org.openbp.common.logger
Class LogUtil

java.lang.Object
  org.openbp.common.logger.LogUtil

public final class LogUtil
extends java.lang.Object

Provides utility methods for an implementation-independant and business object-centered logging. There are a number of differences to regular logging:

• Any Throwable argument given in the argument list at any position will be removed from the argument list and instead will be used as Throwable argument to the logger. The exception messages of all exceptions in the hierarchy will be collected and appended to the log message.
• The message will be expanded by MsgFormat and supports the usual placeholders such as {0} etc. In addition, the placeholder $0 will be processed in the same way as {0} and in addition wrapped in single quotes.
• The expanded log message will be returned by the log methods if the log level is enabled (error log messages will always be expanded regardless of the log level setting so they can be e. g. used as exception messages even if error logging has been disabled).

Method Summary

static java.lang.String	debug(java.lang.Class cls, java.lang.String msg) Logs a debug message with no arguments.
static java.lang.String	debug(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1) Logs a debug message with a single argument.
static java.lang.String	debug(java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs a debug message using an argument array.
static java.lang.String	debug(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2) Logs a debug message with two arguments.
static java.lang.String	debug(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Logs a debug message with tree arguments.
static java.lang.String	debug(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Logs a debug message with four arguments.
static java.lang.String	doLog(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs a message using an argument array.
static java.lang.String	doLog(java.lang.String logLevel, java.lang.String loggerName, java.lang.String msg, java.lang.Object[] args) Logs a message using an argument array.
static java.lang.String	error(java.lang.Class cls, java.lang.String msg) Logs an error message with no arguments.
static java.lang.String	error(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1) Logs an error message with a single argument.
static java.lang.String	error(java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs an error message using an argument array.
static java.lang.String	error(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2) Logs an error message with two arguments.
static java.lang.String	error(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Logs an error message with tree arguments.
static java.lang.String	error(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Logs an error message with four arguments.
static java.lang.String	info(java.lang.Class cls, java.lang.String msg) Logs an informational message with no arguments.
static java.lang.String	info(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1) Logs an informational message with a single argument.
static java.lang.String	info(java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs an informational message using an argument array.
static java.lang.String	info(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2) Logs an informational message with two arguments.
static java.lang.String	info(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Logs an informational message with tree arguments.
static java.lang.String	info(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Logs an informational message with four arguments.
static boolean	isDebugEnabled(java.lang.Class cls) Checks if debug logging is enabled for the given logger.
static boolean	isErrorEnabled(java.lang.Class cls) Checks if error logging is enabled for the given logger.
static boolean	isInfoEnabled(java.lang.Class cls) Checks if info logging is enabled for the given logger.
static boolean	isLoggerEnabled(java.lang.Class cls, java.lang.String logLevel) Checks if the specified logger is enabled.
static boolean	isLoggerEnabled(java.lang.String loggerName, java.lang.String logLevel) Checks if the specified logger is enabled.
static boolean	isTraceEnabled(java.lang.Class cls) Checks if trace logging is enabled for the given logger.
static boolean	isWarnEnabled(java.lang.Class cls) Checks if warn logging is enabled for the given logger.
static java.lang.String	log(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg) Logs a message with no arguments.
static java.lang.String	log(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg, java.lang.Object arg1) Logs a message with a single argument.
static java.lang.String	log(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs a message using an argument array.
static java.lang.String	log(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2) Logs a message with two arguments.
static java.lang.String	log(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Logs a message with tree arguments.
static java.lang.String	log(java.lang.String logLevel, java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Logs a message with four arguments.
static java.lang.String	log(java.lang.String logLevel, java.lang.String loggerName, java.lang.String msg, java.lang.Object[] args) Logs a message using an argument array.
static java.lang.String	trace(java.lang.Class cls, java.lang.String msg) Logs a trace message with no arguments.
static java.lang.String	trace(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1) Logs a trace message with a single argument.
static java.lang.String	trace(java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs a trace message using an argument array.
static java.lang.String	trace(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2) Logs a trace message with two arguments.
static java.lang.String	trace(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Logs a trace message with tree arguments.
static java.lang.String	trace(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Logs a trace message with four arguments.
static java.lang.String	warn(java.lang.Class cls, java.lang.String msg) Logs a warning message with no arguments.
static java.lang.String	warn(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1) Logs a warning message with a single argument.
static java.lang.String	warn(java.lang.Class cls, java.lang.String msg, java.lang.Object[] args) Logs a warning message using an argument array.
static java.lang.String	warn(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2) Logs a warning message with two arguments.
static java.lang.String	warn(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Logs a warning message with tree arguments.
static java.lang.String	warn(java.lang.Class cls, java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Logs a warning message with four arguments.

Methods inherited from class java.lang.Object

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

Method Detail

debug

public static java.lang.String debug(java.lang.Class cls,
                                     java.lang.String msg)

Logs a debug message with no arguments.

debug

public static java.lang.String debug(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1)

Logs a debug message with a single argument.

debug

public static java.lang.String debug(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2)

Logs a debug message with two arguments.

debug

public static java.lang.String debug(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)

Logs a debug message with tree arguments.

debug

public static java.lang.String debug(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3,
                                     java.lang.Object arg4)

Logs a debug message with four arguments.

debug

public static java.lang.String debug(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object[] args)

Logs a debug message using an argument array.

trace

public static java.lang.String trace(java.lang.Class cls,
                                     java.lang.String msg)

Logs a trace message with no arguments.

trace

public static java.lang.String trace(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1)

Logs a trace message with a single argument.

trace

public static java.lang.String trace(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2)

Logs a trace message with two arguments.

trace

public static java.lang.String trace(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)

Logs a trace message with tree arguments.

trace

public static java.lang.String trace(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3,
                                     java.lang.Object arg4)

Logs a trace message with four arguments.

trace

public static java.lang.String trace(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object[] args)

Logs a trace message using an argument array.

info

public static java.lang.String info(java.lang.Class cls,
                                    java.lang.String msg)

Logs an informational message with no arguments.

info

public static java.lang.String info(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1)

Logs an informational message with a single argument.

info

public static java.lang.String info(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1,
                                    java.lang.Object arg2)

Logs an informational message with two arguments.

info

public static java.lang.String info(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3)

Logs an informational message with tree arguments.

info

public static java.lang.String info(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3,
                                    java.lang.Object arg4)

Logs an informational message with four arguments.

info

public static java.lang.String info(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object[] args)

Logs an informational message using an argument array.

warn

public static java.lang.String warn(java.lang.Class cls,
                                    java.lang.String msg)

Logs a warning message with no arguments.

warn

public static java.lang.String warn(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1)

Logs a warning message with a single argument.

warn

public static java.lang.String warn(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1,
                                    java.lang.Object arg2)

Logs a warning message with two arguments.

warn

public static java.lang.String warn(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3)

Logs a warning message with tree arguments.

warn

public static java.lang.String warn(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object arg1,
                                    java.lang.Object arg2,
                                    java.lang.Object arg3,
                                    java.lang.Object arg4)

Logs a warning message with four arguments.

warn

public static java.lang.String warn(java.lang.Class cls,
                                    java.lang.String msg,
                                    java.lang.Object[] args)

Logs a warning message using an argument array.

error

public static java.lang.String error(java.lang.Class cls,
                                     java.lang.String msg)

Logs an error message with no arguments.

error

public static java.lang.String error(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1)

Logs an error message with a single argument.

error

public static java.lang.String error(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2)

Logs an error message with two arguments.

error

public static java.lang.String error(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3)

Logs an error message with tree arguments.

error

public static java.lang.String error(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object arg1,
                                     java.lang.Object arg2,
                                     java.lang.Object arg3,
                                     java.lang.Object arg4)

Logs an error message with four arguments.

error

public static java.lang.String error(java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object[] args)

Logs an error message using an argument array.

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.Class cls,
                                   java.lang.String msg)

Logs a message with no arguments.

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.Class cls,
                                   java.lang.String msg,
                                   java.lang.Object arg1)

Logs a message with a single argument.

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.Class cls,
                                   java.lang.String msg,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2)

Logs a message with two arguments.

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.Class cls,
                                   java.lang.String msg,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2,
                                   java.lang.Object arg3)

Logs a message with tree arguments.

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.Class cls,
                                   java.lang.String msg,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2,
                                   java.lang.Object arg3,
                                   java.lang.Object arg4)

Logs a message with four arguments.

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.Class cls,
                                   java.lang.String msg,
                                   java.lang.Object[] args)

Logs a message using an argument array. This method formats a string message together with an argument array using the standard MsgFormat mechanism, but adds extra processing for null arguments (which are formatted as [null]), and handles an extra exception that might be contained as last value in the argument array.

Parameters:

logLevel - Log level (priority)

cls - Class to be used for logger identification

msg - The message containing placeholder's like {0} etc.
Special convenience: Arguments that should appear in simple quotes ('\'') do not need to be provided as "...''{0}''..." in the log message, the shortcut "...$0..." can be used instead. If the "$" is followed by a non-digit character, it will be printed as it is.
This should eliminate the common error of forgetting a quote, which would confuse MessageFormat.

args - Array of message arguments

Returns:

The formatted message if log logging is enabled for this log level (or if the level is ERROR or higher) or null otherwise

log

public static java.lang.String log(java.lang.String logLevel,
                                   java.lang.String loggerName,
                                   java.lang.String msg,
                                   java.lang.Object[] args)

Logs a message using an argument array. This method formats a string message together with an argument array using the standard MsgFormat mechanism, but adds extra processing for null arguments (which are formatted as [null]), and handles an extra exception that might be contained as last value in the argument array.

Parameters:

logLevel - Log level (priority)

loggerName - Logger name to be used for logger identification

msg - The message containing placeholder's like {0} etc.
Special convenience: Arguments that should appear in simple quotes ('\'') do not need to be provided as "...''{0}''..." in the log message, the shortcut "...$0..." can be used instead. If the "$" is followed by a non-digit character, it will be printed as it is.
This should eliminate the common error of forgetting a quote, which would confuse MessageFormat.

args - Array of message arguments

Returns:

The formatted message if log logging is enabled for this log level (or if the level is ERROR or higher) or null otherwise

doLog

public static java.lang.String doLog(java.lang.String logLevel,
                                     java.lang.Class cls,
                                     java.lang.String msg,
                                     java.lang.Object[] args)

Logs a message using an argument array. This method formats a string message together with an argument array using the standard MsgFormat mechanism, but adds extra processing for null arguments (which are formatted as [null]), and handles an extra exception that might be contained as last value in the argument array.

Parameters:

logLevel - Log level (priority)

cls - Class to be used for logger identification

msg - The message containing placeholder's like {0} etc.
Special convenience: Arguments that should appear in simple quotes ('\'') do not need to be provided as "...''{0}''..." in the log message, the shortcut "...$0..." can be used instead. If the "$" is followed by a non-digit character, it will be printed as it is.
This should eliminate the common error of forgetting a quote, which would confuse MessageFormat.

args - Array of message arguments
If the last parameter is a java.lang.Throwable, it will not be used as message argument, instead it will be passed to the underlying logger method as exception argument.

Returns:

The formatted message if log logging is enabled for this log level (or if the level is ERROR or higher) or null otherwise
This message can be used e. g. as exception message if an exception is to be thrown after the log entry.

isDebugEnabled

public static boolean isDebugEnabled(java.lang.Class cls)

Checks if debug logging is enabled for the given logger.

Parameters:

cls - Class to be used for logger identification

isInfoEnabled

public static boolean isInfoEnabled(java.lang.Class cls)

Checks if info logging is enabled for the given logger.

Parameters:

cls - Class to be used for logger identification

isTraceEnabled

public static boolean isTraceEnabled(java.lang.Class cls)

Checks if trace logging is enabled for the given logger.

Parameters:

cls - Class to be used for logger identification

isWarnEnabled

public static boolean isWarnEnabled(java.lang.Class cls)

Checks if warn logging is enabled for the given logger.

Parameters:

cls - Class to be used for logger identification

isErrorEnabled

public static boolean isErrorEnabled(java.lang.Class cls)

Checks if error logging is enabled for the given logger.

Parameters:

cls - Class to be used for logger identification

isLoggerEnabled

public static boolean isLoggerEnabled(java.lang.Class cls,
                                      java.lang.String logLevel)

Checks if the specified logger is enabled.

isLoggerEnabled

public static boolean isLoggerEnabled(java.lang.String loggerName,
                                      java.lang.String logLevel)

Checks if the specified logger is enabled.

doLog

public static java.lang.String doLog(java.lang.String logLevel,
                                     java.lang.String loggerName,
                                     java.lang.String msg,
                                     java.lang.Object[] args)

Logs a message using an argument array. This method formats a string message together with an argument array using the standard MsgFormat mechanism, but adds extra processing for null arguments (which are formatted as [null]), and handles an extra exception that might be contained as last value in the argument array.

Parameters:

logLevel - Log level (priority)

loggerName - Logger name to be used for logger identification

msg - The message containing placeholder's like {0} etc.
Special convenience: Arguments that should appear in simple quotes ('\'') do not need to be provided as "...''{0}''..." in the log message, the shortcut "...$0..." can be used instead. If the "$" is followed by a non-digit character, it will be printed as it is.
This should eliminate the common error of forgetting a quote, which would confuse MessageFormat.

args - Array of message arguments
If the last parameter is a java.lang.Throwable, it will not be used as message argument, instead it will be passed to the underlying logger method as exception argument.

Returns:

The formatted message if log logging is enabled for this log level (or if the level is ERROR or higher) or null otherwise
This message can be used e. g. as exception message if an exception is to be thrown after the log entry.