eu.davidea.flexibleadapter.utils

Class Log

java.lang.Object

eu.davidea.flexibleadapter.utils.Log

public class Log
extends java.lang.Object

Utility class for Android libraries, that simplifies the use of Log by improving the call to all log methods by supplying arguments as parameters '%s' instead of creating a string. This avoids useless memory allocations when not requested: the StringBuilder itself, the buffer and the String object. The new methods check in advance if the level is enabled and only after the string message with arguments is created.

Note: This class can work in collaboration with Logger.

Others features are:

• Automatic TAG corresponding to the caller class name.
• Runtime log level without the need of props file (useful for libraries).
• Method name with line number.

Use Log.Level.SUPPRESS to disable all logs. For instance:

 if (BuildConfig.DEBUG) {
     Log.setLevel(Level.INFO);
 } else {
     Log.setLevel(Level.SUPPRESS);
 }
 Log.i("Message arg1=%s, arg2=%s", arg1, arg2);
 

Since:

02/06/2017

See Also:

Logger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Log.Level Annotation interface for log level: Log.Level.VERBOSE, Log.Level.DEBUG, Log.Level.INFO, Log.Level.WARN, Log.Level.ERROR, Log.Level.SUPPRESS

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	customTag

Method Summary

Modifier and Type	Method and Description
static void	d(java.lang.String msg, java.lang.Object... args) Sends a Log.Level.DEBUG log message.
static void	e(java.lang.String msg, java.lang.Object... args) Sends an Log.Level.ERROR log message.
static void	e(java.lang.Throwable t, java.lang.String msg, java.lang.Object... args) Sends an Log.Level.ERROR log message with the Exception at the end of the message.
static void	i(java.lang.String msg, java.lang.Object... args) Sends an Log.Level.INFO log message.
static boolean	isDebugEnabled()
static boolean	isErrorEnabled()
static boolean	isInfoEnabled()
static boolean	isVerboseEnabled()
static boolean	isWarnEnabled()
static void	iTag(java.lang.String tag, java.lang.String msg, java.lang.Object... args) As i(String, Object...) but with custom tag for one call only.
static void	logMethodName(boolean method, boolean line) Allows to log method name and line number from where the log is called.
static void	setLevel(int level)
static void	useTag(java.lang.String customTag) Sets a general static custom tag for ALL log calls.
static void	v(java.lang.String msg, java.lang.Object... args) Sends a Log.Level.VERBOSE log message.
static void	w(java.lang.String msg, java.lang.Object... args) Sends a Log.Level.WARN log message.
static void	w(java.lang.Throwable t, java.lang.String msg, java.lang.Object... args) Sends a Log.Level.WARN log message with the Exception at the end of the message.
static void	wtf(java.lang.String msg, java.lang.Object... args) What a Terrible Failure: Report a condition that should never happen.
static void	wtf(java.lang.Throwable t, java.lang.String msg, java.lang.Object... args) What a Terrible Failure: Report a condition that should never happen with the Exception at the end of the message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

customTag

public static java.lang.String customTag

Method Detail

setLevel

public static void setLevel(int level)

logMethodName

public static void logMethodName(boolean method,
                                 boolean line)

Allows to log method name and line number from where the log is called.

- With method name: [method] msg.
- With line number: [method:line] msg.

Note: Line number needs method name enabled.

Parameters:

method - true to print method name at the beginning of the message, false otherwise

line - true to print line number after the method name, false otherwise

isVerboseEnabled

public static boolean isVerboseEnabled()

isDebugEnabled

public static boolean isDebugEnabled()

isInfoEnabled

public static boolean isInfoEnabled()

isWarnEnabled

public static boolean isWarnEnabled()

isErrorEnabled

public static boolean isErrorEnabled()

v

public static void v(java.lang.String msg,
                     java.lang.Object... args)

Sends a Log.Level.VERBOSE log message.

Parameters:

msg - the message you would like logged

args - the extra arguments for the message

d

public static void d(java.lang.String msg,
                     java.lang.Object... args)

Sends a Log.Level.DEBUG log message.

Parameters:

msg - the message you would like logged

args - the extra arguments for the message

i

public static void i(java.lang.String msg,
                     java.lang.Object... args)

Sends an Log.Level.INFO log message.

Parameters:

msg - the message you would like logged

args - the extra arguments for the message

iTag

public static void iTag(java.lang.String tag,
                        java.lang.String msg,
                        java.lang.Object... args)

As i(String, Object...) but with custom tag for one call only.

Parameters:

tag - custom tag, used to identify the source of a log message

msg - the message you would like logged

args - the extra arguments for the message

w

public static void w(java.lang.String msg,
                     java.lang.Object... args)

Sends a Log.Level.WARN log message.

Parameters:

msg - the message you would like logged

args - the extra arguments for the message

w

public static void w(java.lang.Throwable t,
                     java.lang.String msg,
                     java.lang.Object... args)

Sends a Log.Level.WARN log message with the Exception at the end of the message.

Parameters:

t - The exception to log

msg - the message you would like logged

args - the extra arguments for the message

e

public static void e(java.lang.String msg,
                     java.lang.Object... args)

Sends an Log.Level.ERROR log message.

Parameters:

msg - the message you would like logged

args - the extra arguments for the message

e

public static void e(java.lang.Throwable t,
                     java.lang.String msg,
                     java.lang.Object... args)

Sends an Log.Level.ERROR log message with the Exception at the end of the message.

Parameters:

t - The exception to log

msg - the message you would like logged

args - the extra arguments for the message

wtf

public static void wtf(java.lang.String msg,
                       java.lang.Object... args)

What a Terrible Failure: Report a condition that should never happen.

Parameters:

msg - the message you would like logged

args - the extra arguments for the message

wtf

public static void wtf(java.lang.Throwable t,
                       java.lang.String msg,
                       java.lang.Object... args)

What a Terrible Failure: Report a condition that should never happen with the Exception at the end of the message.

Parameters:

t - The exception to log

msg - the message you would like logged

args - the extra arguments for the message

useTag

public static void useTag(java.lang.String customTag)

Sets a general static custom tag for ALL log calls.

Note: If a Logger instance is created, this custom tag will be reset to null and current filename will be used instead.

Parameters:

customTag - general static tag for ALL logs.