universum.studios.android.util

Class Logger

java.lang.Object

universum.studios.android.util.Logger

public class Logger
extends Object

Logging utility class. Uses all log methods from Log. To enable or disable specific logging you can call enable(int), disable(int), like:

 // ...

 // Enable only DEBUG and INFO logging.
 Logger.disableAll();
 Logger.enable(Logger.DEBUG | Logger.INFO);

 // ...
 

to match your specific logging requirements.

Default enabled logs

DEBUG, INFO, WARN, ERROR

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Logger.LogType Defines an annotation for determining set of allowed log flags for enable(...), disable(...) methods.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG The flag to enable/disable log output for the DEBUG logging.
static int	ERROR The flag to enable/disable log output for the ERROR logging.
static int	INFO The flag to enable/disable log output for the INFO logging.
static int	sEnabledLogs Set of output flags determining which log outputs are enabled.
static int	VERBOSE The flag to enable/disable log output for the VERBOSE logging.
static int	WARN The flag to enable/disable log output for the WARN logging.
static int	WTF The flag to enable/disable log output for the WTF logging.

Method Summary

Modifier and Type	Method and Description
static void	d(String tag, String msg) Wrapped Log.d(String, String).
static void	d(String tag, String msg, Throwable tr) Wrapped Log.d(String, String, Throwable).
static void	disable(int logFlag) Disables the messages output in the log cat for the requested log output type/-s.
static void	disableAll() Disables the messages output in the log cat for all log output types.
static void	e(String tag, String msg) Wrapped Log.e(String, String).
static void	e(String tag, String msg, Throwable tr) Wrapped Log.e(String, String, Throwable).
static void	enable(int logFlag) Enables the messages output in the log cat for the requested log output type/-s.
static void	enableAll() Enables the messages output in the log cat for the all log output types.
static String	getStackTraceString(Throwable tr) Wrapped Log.getStackTraceString(Throwable).
static void	i(String tag, String msg) Wrapped Log.i(String, String).
static void	i(String tag, String msg, Throwable tr) Wrapped Log.i(String, String, Throwable).
static boolean	isEnabled(int logFlag) Returns flag indicating whether the log output for the specified logFlag is currently enabled or not.
static boolean	isLoggable(String tag, int level) Wrapped Log.isLoggable(String, int).
static void	reset() Resets the current state of Logger to the default one.
static void	switchToDebugMode() Enables all log outputs except WTF.
static void	switchToReleaseMode() Enables log output for INFO, WARN, ERROR.
static void	v(String tag, String msg) Wrapped Log.v(String, String).
static void	v(String tag, String msg, Throwable tr) Wrapped Log.v(String, String, Throwable).
static void	w(String tag, String msg) Wrapped Log.w(String, String).
static void	w(String tag, String msg, Throwable tr) Wrapped Log.w(String, String, Throwable).
static void	w(String tag, Throwable tr) Wrapped Log.w(String, Throwable).
static void	wtf(String tag, String msg) Wrapped Log.wtf(String, String).
static void	wtf(String tag, String msg, Throwable tr) Wrapped Log.wtf(String, String, Throwable).
static void	wtf(String tag, Throwable tr) Wrapped Log.wtf(String, Throwable).

Methods inherited from class java.lang.Object

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

Field Detail

VERBOSE

public static final int VERBOSE

The flag to enable/disable log output for the VERBOSE logging. See v(String, String), v(String, String, Throwable) for more info.

See Also:

Constant Field Values

DEBUG

public static final int DEBUG

The flag to enable/disable log output for the DEBUG logging. See d(String, String), d(String, String, Throwable) for more info.

See Also:

Constant Field Values

INFO

public static final int INFO

The flag to enable/disable log output for the INFO logging. See i(String, String), i(String, String, Throwable) for more info.

See Also:

Constant Field Values

WARN

public static final int WARN

The flag to enable/disable log output for the WARN logging. See w(String, String), w(String, Throwable), w(String, String, Throwable) for more info.

See Also:

Constant Field Values

ERROR

public static final int ERROR

The flag to enable/disable log output for the ERROR logging. See e(String, String), e(String, String, Throwable) for more info.

See Also:

Constant Field Values

WTF

public static final int WTF

The flag to enable/disable log output for the WTF logging. See wtf(String, String), wtf(String, Throwable), wtf(String, String, Throwable) for more info.

See Also:

Constant Field Values

sEnabledLogs

public static int sEnabledLogs

Set of output flags determining which log outputs are enabled.

Method Detail

reset

public static void reset()

Resets the current state of Logger to the default one.

enable

public static void enable(int logFlag)

Enables the messages output in the log cat for the requested log output type/-s.

Parameters:

logFlag - The flag of the desired log output. One of VERBOSE, DEBUG, INFO, WARN, ERROR, WTF or theirs combination.

disable

public static void disable(int logFlag)

Disables the messages output in the log cat for the requested log output type/-s.

Parameters:

logFlag - The flag of the desired log output. One of VERBOSE, DEBUG, INFO, WARN, ERROR, WTF or theirs combination.

enableAll

public static void enableAll()

Enables the messages output in the log cat for the all log output types.

See Also:

disableAll(), isEnabled(int)

disableAll

public static void disableAll()

Disables the messages output in the log cat for all log output types.

See Also:

disableAll(), isEnabled(int)

isEnabled

public static boolean isEnabled(int logFlag)

Returns flag indicating whether the log output for the specified logFlag is currently enabled or not.

Parameters:

logFlag - The flag of the desired log output. One of the VERBOSE, DEBUG, INFO, WARN, ERROR, WTF or theirs combination.

Returns:

True if the specified log flag is currently presented, false otherwise.

switchToDebugMode

public static void switchToDebugMode()

Enables all log outputs except WTF. All currently enabled logs will be disabled.

See Also:

switchToReleaseMode()

switchToReleaseMode

public static void switchToReleaseMode()

Enables log output for INFO, WARN, ERROR. All currently enabled logs will be disabled.

See Also:

switchToDebugMode()

d

public static void d(@NonNull
                     String tag,
                     @NonNull
                     String msg)

Wrapped Log.d(String, String).

Message will be outputted only, if the DEBUG flag is set.

d

public static void d(@NonNull
                     String tag,
                     @NonNull
                     String msg,
                     @Nullable
                     Throwable tr)

Wrapped Log.d(String, String, Throwable).

Message will be outputted only, if the DEBUG flag is set.

v

public static void v(@NonNull
                     String tag,
                     @NonNull
                     String msg)

Wrapped Log.v(String, String).

Message will be outputted only, if the VERBOSE flag is set.

v

public static void v(@NonNull
                     String tag,
                     @NonNull
                     String msg,
                     @Nullable
                     Throwable tr)

Wrapped Log.v(String, String, Throwable).

Message will be outputted only, if the VERBOSE flag is set.

i

public static void i(@NonNull
                     String tag,
                     @NonNull
                     String msg)

Wrapped Log.i(String, String).

Message will be outputted only, if the INFO flag is set.

i

public static void i(@NonNull
                     String tag,
                     @NonNull
                     String msg,
                     @Nullable
                     Throwable tr)

Wrapped Log.i(String, String, Throwable).

Message will be outputted only, if the INFO flag is set.

w

public static void w(@NonNull
                     String tag,
                     @NonNull
                     String msg)

Wrapped Log.w(String, String).

Message will be outputted only, if the WARN flag is set.

w

public static void w(@NonNull
                     String tag,
                     @Nullable
                     Throwable tr)

Wrapped Log.w(String, Throwable).

Message will be outputted only, if the WARN flag is set.

w

public static void w(@NonNull
                     String tag,
                     @NonNull
                     String msg,
                     @Nullable
                     Throwable tr)

Wrapped Log.w(String, String, Throwable).

Message will be outputted only, if the WARN flag is set.

e

public static void e(@NonNull
                     String tag,
                     @NonNull
                     String msg)

Wrapped Log.e(String, String).

Message will be outputted only, if the ERROR flag is set.

e

public static void e(@NonNull
                     String tag,
                     @NonNull
                     String msg,
                     @Nullable
                     Throwable tr)

Wrapped Log.e(String, String, Throwable).

Message will be outputted only, if the ERROR flag is set.

wtf

public static void wtf(@NonNull
                       String tag,
                       @NonNull
                       String msg)

Wrapped Log.wtf(String, String).

Message will be outputted only, if the WTF flag is set.

wtf

public static void wtf(@NonNull
                       String tag,
                       @Nullable
                       Throwable tr)

Wrapped Log.wtf(String, Throwable).

Message will be outputted only, if the WTF flag is set.

wtf

public static void wtf(@NonNull
                       String tag,
                       @NonNull
                       String msg,
                       @Nullable
                       Throwable tr)

Wrapped Log.wtf(String, String, Throwable).

Message will be outputted only, if the WTF flag is set.

isLoggable

public static boolean isLoggable(@NonNull
                                 String tag,
                                 int level)

Wrapped Log.isLoggable(String, int).

getStackTraceString

public static String getStackTraceString(@Nullable
                                         Throwable tr)

Wrapped Log.getStackTraceString(Throwable).