com.alee.managers.log
Class Log

java.lang.Object
  extended by com.alee.managers.log.Log

public class Log
extends java.lang.Object

Base logging class which can be used anywhere to log messages and exceptions.

Author:
Mikle Garin

Field Summary
protected static boolean debugEnabled
          Whether debug messages are enabled or not.
protected static boolean initialized
          Whether Log is initialized or not.
protected static java.util.Map<java.lang.Class,org.slf4j.Logger> loggers
          Loggers cache.
protected static java.util.Map<java.lang.Class,java.lang.Boolean> loggingEnabled
          Logging enabled/disabled conditions.
protected static java.lang.Object logLock
          Logger synchronization lock object.
protected static LogPrefixSupplier prefixSupplier
          Custom log messages prefix supplier.
 
Constructor Summary
Log()
           
 
Method Summary
static void debug(java.lang.Object logFor, java.lang.String message, java.lang.Object... data)
          Writes specified information message into log.
static void debug(java.lang.String message, java.lang.Object... data)
          Writes specified information message into log.
static void disableLogging(java.lang.Object object)
          Disables logging for the specified class type.
static void enableLogging(java.lang.Object object)
          Enables logging for the specified class type.
static void error(java.lang.Object logFor, java.lang.String message)
          Writes specified exception message into log.
static void error(java.lang.Object logFor, java.lang.String message, java.lang.Throwable throwable)
          Writes specified exception message into log.
static void error(java.lang.Object logFor, java.lang.Throwable throwable)
          Writes specified exception into log.
static void error(java.lang.String message)
          Writes specified exception message into log.
static void error(java.lang.String message, java.lang.Throwable throwable)
          Writes specified exception message into log.
static void error(java.lang.Throwable throwable)
          Writes specified exception into log.
static org.slf4j.Logger get()
          Returns logger for the requesting class.
static org.slf4j.Logger getLogger()
          Returns logger for the requesting class.
static org.slf4j.Logger getLogger(java.lang.Object object)
          Returns logger for the specified class type.
static java.lang.String getPrefix(LogMessageType type, java.lang.String message)
          Returns prefix for specific log message.
static java.lang.String getPrefix(LogMessageType type, java.lang.String message, java.lang.Throwable throwable)
          Returns prefix for specific log message.
static LogPrefixSupplier getPrefixSupplier()
          Returns custom log prefix supplier.
static void info(java.lang.Object logFor, java.lang.String message, java.lang.Object... data)
          Writes specified information message into log.
static void info(java.lang.String message, java.lang.Object... data)
          Writes specified information message into log.
static void initialize()
          Initializes SettingsManager.
static boolean isDebugEnabled()
          Returns whether debug messages are enabled or not.
static boolean isLoggingEnabled(java.lang.Object object)
          Returns whether logging for the specified class type is enabled or not.
static void setDebugEnabled(boolean debugEnabled)
          Sets whether debug messages are enabled or not.
static void setLoggingEnabled(java.lang.Object object, boolean enabled)
          Sets whether logging for the specified class type is enabled or not.
static void setPrefixSupplier(LogPrefixSupplier supplier)
          Sets custom log prefix supplier
static void warn(java.lang.Object logFor, java.lang.String message)
          Writes specified warning message into log.
static void warn(java.lang.Object logFor, java.lang.String message, java.lang.Throwable throwable)
          Writes specified warning message into log.
static void warn(java.lang.String message)
          Writes specified warning message into log.
static void warn(java.lang.String message, java.lang.Throwable throwable)
          Writes specified warning message into log.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

loggers

protected static final java.util.Map<java.lang.Class,org.slf4j.Logger> loggers
Loggers cache.


loggingEnabled

protected static final java.util.Map<java.lang.Class,java.lang.Boolean> loggingEnabled
Logging enabled/disabled conditions.


logLock

protected static final java.lang.Object logLock
Logger synchronization lock object.


debugEnabled

protected static boolean debugEnabled
Whether debug messages are enabled or not.


prefixSupplier

protected static LogPrefixSupplier prefixSupplier
Custom log messages prefix supplier.


initialized

protected static boolean initialized
Whether Log is initialized or not.

Constructor Detail

Log

public Log()
Method Detail

initialize

public static void initialize()
Initializes SettingsManager.


isDebugEnabled

public static boolean isDebugEnabled()
Returns whether debug messages are enabled or not.

Returns:
true if debug messages are enabled, false otherwise

setDebugEnabled

public static void setDebugEnabled(boolean debugEnabled)
Sets whether debug messages are enabled or not.

Parameters:
debugEnabled - whether debug messages are enabled or not

getPrefixSupplier

public static LogPrefixSupplier getPrefixSupplier()
Returns custom log prefix supplier.

Returns:
custom log prefix supplier

setPrefixSupplier

public static void setPrefixSupplier(LogPrefixSupplier supplier)
Sets custom log prefix supplier

Parameters:
supplier - custom log prefix supplier

info

public static void info(java.lang.String message,
                        java.lang.Object... data)
Writes specified information message into log.

Parameters:
message - information message
data - formatting data

info

public static void info(java.lang.Object logFor,
                        java.lang.String message,
                        java.lang.Object... data)
Writes specified information message into log.

Parameters:
logFor - where to log message is attached
message - information message
data - formatting data

debug

public static void debug(java.lang.String message,
                         java.lang.Object... data)
Writes specified information message into log.

Parameters:
message - debugEnabled message
data - formatting data

debug

public static void debug(java.lang.Object logFor,
                         java.lang.String message,
                         java.lang.Object... data)
Writes specified information message into log.

Parameters:
logFor - where to log message is attached
message - debugEnabled message
data - formatting data

warn

public static void warn(java.lang.String message)
Writes specified warning message into log.

Parameters:
message - warning message

warn

public static void warn(java.lang.Object logFor,
                        java.lang.String message)
Writes specified warning message into log.

Parameters:
logFor - where to log message is attached
message - warning message

warn

public static void warn(java.lang.String message,
                        java.lang.Throwable throwable)
Writes specified warning message into log.

Parameters:
message - warning message
throwable - exception

warn

public static void warn(java.lang.Object logFor,
                        java.lang.String message,
                        java.lang.Throwable throwable)
Writes specified warning message into log.

Parameters:
logFor - where to log message is attached
message - warning message
throwable - exception

error

public static void error(java.lang.Throwable throwable)
Writes specified exception into log.

Parameters:
throwable - exception

error

public static void error(java.lang.Object logFor,
                         java.lang.Throwable throwable)
Writes specified exception into log.

Parameters:
logFor - where to log message is attached
throwable - exception

error

public static void error(java.lang.String message,
                         java.lang.Throwable throwable)
Writes specified exception message into log.

Parameters:
message - exception message
throwable - exception

error

public static void error(java.lang.Object logFor,
                         java.lang.String message,
                         java.lang.Throwable throwable)
Writes specified exception message into log.

Parameters:
logFor - where to log message is attached
message - exception message
throwable - exception

error

public static void error(java.lang.String message)
Writes specified exception message into log.

Parameters:
message - exception message

error

public static void error(java.lang.Object logFor,
                         java.lang.String message)
Writes specified exception message into log.

Parameters:
logFor - where to log message is attached
message - exception message

getPrefix

public static java.lang.String getPrefix(LogMessageType type,
                                         java.lang.String message)
Returns prefix for specific log message.

Parameters:
type - message type
message - message
Returns:
prefix for specific log message

getPrefix

public static java.lang.String getPrefix(LogMessageType type,
                                         java.lang.String message,
                                         java.lang.Throwable throwable)
Returns prefix for specific log message.

Parameters:
type - message type
message - message
throwable - exception
Returns:
prefix for specific log message

get

public static org.slf4j.Logger get()
Returns logger for the requesting class.

Returns:
logger for the requesting class

getLogger

public static org.slf4j.Logger getLogger()
Returns logger for the requesting class.

Returns:
logger for the requesting class

getLogger

public static org.slf4j.Logger getLogger(java.lang.Object object)
Returns logger for the specified class type.

Parameters:
object - class type or object type
Returns:
logger for the specified class type

disableLogging

public static void disableLogging(java.lang.Object object)
Disables logging for the specified class type.

Parameters:
object - class type or object type

enableLogging

public static void enableLogging(java.lang.Object object)
Enables logging for the specified class type.

Parameters:
object - class type or object type

setLoggingEnabled

public static void setLoggingEnabled(java.lang.Object object,
                                     boolean enabled)
Sets whether logging for the specified class type is enabled or not.

Parameters:
object - class type or object type
enabled - whether logging is enabled or not

isLoggingEnabled

public static boolean isLoggingEnabled(java.lang.Object object)
Returns whether logging for the specified class type is enabled or not.

Parameters:
object - class type or object type
Returns:
true if logging for the specified class type is enabled, false otherwise