.. java:import:: com.idopte.scmapi SCMEnvironment

Log
===

.. java:package:: com.idopte.tools
   :noindex:

.. java:type:: public interface Log

   Interface used for logging messages from middleware. Create a class implementing this interface and call \ :java:ref:`Log.setLog(Log)`\  to redirect all traces to your \ :java:ref:`Log`\  implementation.

Methods
-------
d
^

.. java:method::  void d(String tag, String msg)
   :outertype: Log

   Called when a DEBUG log message is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.

d
^

.. java:method::  void d(String tag, String msg, Throwable tr)
   :outertype: Log

   Called when a DEBUG log message and an exception are sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value may be null.
   :param tr: An exception to log. This value may be null.

e
^

.. java:method::  void e(String tag, String msg)
   :outertype: Log

   Called when an ERROR log message is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.

e
^

.. java:method::  void e(String tag, String msg, Throwable tr)
   :outertype: Log

   Called when a ERROR log message and an exception are sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value may be null.
   :param tr: An exception to log. This value may be null.

i
^

.. java:method::  void i(String tag, String msg)
   :outertype: Log

   Called when an INFO log message is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.

i
^

.. java:method::  void i(String tag, String msg, Throwable tr)
   :outertype: Log

   Called when a INFO log message and an exception are sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value may be null.
   :param tr: An exception to log. This value may be null.

setLog
^^^^^^

.. java:method:: static void setLog(Log log)
   :outertype: Log

   Set and use given \ :java:ref:`Log`\  object. If passed \ :java:ref:`Log`\  is not ``null``, calling \ :java:ref:`SCMEnvironment.startRemoteLogsRecording(String)`\  is not possible.

   :param log: a \ :java:ref:`Log`\  object to use for logging, or ``null`` for resetting to default behaviour.

traceNative
^^^^^^^^^^^

.. java:method::  void traceNative(String msg)
   :outertype: Log

   Called when a message coming from Idopte Middleware native code is sent. Log level is not specified.

   :param msg: The message you would like logged. This value cannot be null.

v
^

.. java:method::  void v(String tag, String msg)
   :outertype: Log

   Called when a VERBOSE log message is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.

v
^

.. java:method::  void v(String tag, String msg, Throwable tr)
   :outertype: Log

   Called when a VERBOSE log message and an exception are sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value may be null.
   :param tr: An exception to log. This value may be null.

w
^

.. java:method::  void w(String tag, String msg)
   :outertype: Log

   Called when a WARN log message is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.

w
^

.. java:method::  void w(String tag, String msg, Throwable tr)
   :outertype: Log

   Called when a WARN log message and an exception are sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value may be null.
   :param tr: An exception to log. This value may be null.

wtf
^^^

.. java:method::  void wtf(String tag, String msg)
   :outertype: Log

   What a Terrible Failure: Called when an exception that should never happen is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.

wtf
^^^

.. java:method::  void wtf(String tag, String msg, Throwable tr)
   :outertype: Log

   What a Terrible Failure: Called when an exception that should never happen is sent.

   :param tag: Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs. This value may be null.
   :param msg: The message you would like logged. This value cannot be null.
   :param tr: An exception to log. This value may be null.