org.factor45.malabarista.logging

Class Logger

java.lang.Object

org.factor45.malabarista.logging.Logger

public class Logger
extends Object

Facade for SLF4J's logger.

Offers java 5 syntax support (varargs) and performs some optimizations.

Author:

Bruno de Carvalho

Constructor Summary

Constructors

Constructor and Description
Logger(Class clazz) Default constructor
Logger(String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(String message) Print a debug message to the logs.
void	debug(String message, Object... parameters) Print a formatted debug message to the logs, with an arbitrary number of parameters.
void	debug(String message, Object parameter) Print a formatted debug message to the logs, with one parameter.
void	debug(String message, Throwable throwable) Print a debug message with an exception.
void	debug(String message, Throwable throwable, Object... parameters) Print a formatted debug message to the logs, with an arbitrary number of parameters and an exception.
void	error(String message) Print an error message to the logs.
void	error(String message, Object... parameters) Print a formatted error message to the logs, with an arbitrary number of parameters.
void	error(String message, Object parameter) Print a formatted error message to the logs, with one parameter.
void	error(String message, Throwable throwable) Print an error message with an exception.
void	error(String message, Throwable throwable, Object... parameters) Print a formatted debug message to the logs, with an arbitrary number of parameters and an exception.
static Logger	getLogger(Class clazz) Return a logger for a given class.
static Logger	getLogger(String name)
String	getName() Return the name of the logger.
void	info(String message) Print a info message to the logs.
void	info(String message, Object... parameters) Print a formatted info message to the logs, with an arbitrary number of parameters.
void	info(String message, Object parameter) Print a formatted info message to the logs, with one parameter.
void	info(String message, Throwable throwable) Print an info message with an exception.
void	info(String message, Throwable throwable, Object... parameters) Print a formatted info message to the logs, with an arbitrary number of parameters and an exception.
boolean	isDebugEnabled() Test whether debug logging level is enabled.
boolean	isErrorEnabled() Test whether error logging level is enabled.
boolean	isInfoEnabled() Test whether info logging level is enabled.
boolean	isTraceEnabled() Test whether trace logging level is enabled.
boolean	isWarnEnabled() Test whether warn logging level is enabled.
void	trace(String message) Print a trace message to the logs.
void	trace(String message, Object... parameters) Print a formatted trace message to the logs, with an arbitrary number of parameters.
void	trace(String message, Object parameter) Print a formatted trace message to the logs, with one parameter.
void	trace(String message, Throwable throwable) Print a trace message with an exception.
void	trace(String message, Throwable throwable, Object... parameters) Print a formatted trace message to the logs, with an arbitrary number of parameters and an exception.
void	warn(String message) Print a warning message to the logs.
void	warn(String message, Object... parameters) Print a formatted warning message to the logs, with an arbitrary number of parameters.
void	warn(String message, Object parameter) Print a formatted warning message to the logs, with one parameter.
void	warn(String message, Throwable throwable) Print a warning message with an exception.
void	warn(String message, Throwable throwable, Object... parameters) Print a formatted warn message to the logs, with an arbitrary number of parameters and an exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(Class clazz)

Default constructor

Parameters:

clazz - Name of the class to log.

Logger

public Logger(String name)

Method Detail

getLogger

public static Logger getLogger(Class clazz)

Return a logger for a given class.

Parameters:

clazz - Class.

Returns:

Logger for a class.

getLogger

public static Logger getLogger(String name)

getName

public String getName()

Return the name of the logger.

Returns:

Name of the logger.

isTraceEnabled

public boolean isTraceEnabled()

Test whether trace logging level is enabled.

Returns:

true if trace logging level is enabled, false otherwise.

trace

public void trace(String message)

Print a trace message to the logs.

Parameters:

message - Message to be logged.

trace

public void trace(String message,
         Object parameter)

Print a formatted trace message to the logs, with one parameter.

Parameters:

message - Message to be logged.

parameter - Message parameter.

trace

public void trace(String message,
         Object... parameters)

Print a formatted trace message to the logs, with an arbitrary number of parameters.

Parameters:

message - Message to be logged.

parameters - Array of parameters.

trace

public void trace(String message,
         Throwable throwable)

Print a trace message with an exception.

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

trace

public void trace(String message,
         Throwable throwable,
         Object... parameters)

Print a formatted trace message to the logs, with an arbitrary number of parameters and an exception.

In order for this to work a workaround has to be done, because SLF4J's api only allows for exceptions to be logged alongside with a String, thus disabling formatted message AND exception logging.
Resorting to SLF4J's MessageFormater to format the message with the parameters into a string and then passing that string as the message, it is possible to have the best of both worlds.
In order to avoid incurring the overhead of this process, before doing it, a test to check if the log level is enabled is done.

NOTE: The order of the throwable and object array is switched due to Java language limitations, but the exception always shows up AFTER the formatted message.

Parameters:

message - Message to be formatted.

throwable - Throwable to be logged.

parameters - Parameters to format the message.

isDebugEnabled

public boolean isDebugEnabled()

Test whether debug logging level is enabled.

Returns:

true if debug logging level is enabled, false otherwise.

debug

public void debug(String message)

Print a debug message to the logs.

Parameters:

message - Message to be logged.

debug

public void debug(String message,
         Object parameter)

Print a formatted debug message to the logs, with one parameter.

Parameters:

message - Message to be logged.

parameter - Message parameter.

debug

public void debug(String message,
         Object... parameters)

Print a formatted debug message to the logs, with an arbitrary number of parameters.

Parameters:

message - Message to be logged.

parameters - Array of parameters.

debug

public void debug(String message,
         Throwable throwable)

Print a debug message with an exception.

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

debug

public void debug(String message,
         Throwable throwable,
         Object... parameters)

Print a formatted debug message to the logs, with an arbitrary number of parameters and an exception.

In order for this to work a workaround has to be done, because SLF4J's api only allows for exceptions to be logged alongside with a String, thus disabling formatted message AND exception logging.
Resorting to SLF4J's MessageFormater to format the message with the parameters into a string and then passing that string as the message, it is possible to have the best of both worlds.
In order to avoid incurring the overhead of this process, before doing it, a test to check if the log level is enabled is done.

NOTE: The order of the throwable and object array is switched due to Java language limitations, but the exception always shows up AFTER the formatted message.

Parameters:

message - Message to be formatted.

throwable - Throwable to be logged.

parameters - Parameters to format the message.

isInfoEnabled

public boolean isInfoEnabled()

Test whether info logging level is enabled.

Returns:

true if info logging level is enabled, false otherwise.

info

public void info(String message)

Print a info message to the logs.

Parameters:

message - Message to be logged.

info

public void info(String message,
        Object parameter)

Print a formatted info message to the logs, with one parameter.

Parameters:

message - Message to be logged.

parameter - Message parameter.

info

public void info(String message,
        Object... parameters)

Print a formatted info message to the logs, with an arbitrary number of parameters.

Parameters:

message - Message to be logged.

parameters - Array of parameters.

info

public void info(String message,
        Throwable throwable)

Print an info message with an exception.

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

info

public void info(String message,
        Throwable throwable,
        Object... parameters)

Print a formatted info message to the logs, with an arbitrary number of parameters and an exception.

In order for this to work a workaround has to be done, because SLF4J's api only allows for exceptions to be logged alongside with a String, thus disabling formatted message AND exception logging.
Resorting to SLF4J's MessageFormater to format the message with the parameters into a string and then passing that string as the message, it is possible to have the best of both worlds.
In order to avoid incurring the overhead of this process, before doing it, a test to check if the log level is enabled is done.

NOTE: The order of the throwable and object array is switched due to Java language limitations, but the exception always shows up AFTER the formatted message.

Parameters:

message - Message to be formatted.

throwable - Throwable to be logged.

parameters - Parameters to format the message.

isWarnEnabled

public boolean isWarnEnabled()

Test whether warn logging level is enabled.

Returns:

true if warn logging level is enabled, false otherwise.

warn

public void warn(String message)

Print a warning message to the logs.

Parameters:

message - Message to be logged.

warn

public void warn(String message,
        Object parameter)

Print a formatted warning message to the logs, with one parameter.

Parameters:

message - Message to be logged.

parameter - Message parameter.

warn

public void warn(String message,
        Object... parameters)

Print a formatted warning message to the logs, with an arbitrary number of parameters.

Parameters:

message - Message to be logged.

parameters - Array of parameters.

warn

public void warn(String message,
        Throwable throwable)

Print a warning message with an exception.

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

warn

public void warn(String message,
        Throwable throwable,
        Object... parameters)

Print a formatted warn message to the logs, with an arbitrary number of parameters and an exception.

In order for this to work a workaround has to be done, because SLF4J's api only allows for exceptions to be logged alongside with a String, thus disabling formatted message AND exception logging.
Resorting to SLF4J's MessageFormater to format the message with the parameters into a string and then passing that string as the message, it is possible to have the best of both worlds.
In order to avoid incurring the overhead of this process, before doing it, a test to check if the log level is enabled is done.

NOTE: The order of the throwable and object array is switched due to Java language limitations, but the exception always shows up AFTER the formatted message.

Parameters:

message - Message to be formatted.

throwable - Throwable to be logged.

parameters - Parameters to format the message.

isErrorEnabled

public boolean isErrorEnabled()

Test whether error logging level is enabled.

Returns:

true if error logging level is enabled, false otherwise.

error

public void error(String message)

Print an error message to the logs.

Parameters:

message - Message to be logged.

error

public void error(String message,
         Object parameter)

Print a formatted error message to the logs, with one parameter.

Parameters:

message - Message to be logged.

parameter - Message parameter.

error

public void error(String message,
         Object... parameters)

Print a formatted error message to the logs, with an arbitrary number of parameters.

Parameters:

message - Message to be logged.

parameters - Array of parameters.

error

public void error(String message,
         Throwable throwable)

Print an error message with an exception.

Parameters:

message - Message to be logged.

throwable - Throwable to be logged.

error

public void error(String message,
         Throwable throwable,
         Object... parameters)

Print a formatted debug message to the logs, with an arbitrary number of parameters and an exception.

In order for this to work a workaround has to be done, because SLF4J's api only allows for exceptions to be logged alongside with a String, thus disabling formatted message AND exception logging.
Resorting to SLF4J's MessageFormater to format the message with the parameters into a string and then passing that string as the message, it is possible to have the best of both worlds.
In order to avoid incurring the overhead of this process, before doing it, a test to check if the log level is enabled is done.

NOTE: The order of the throwable and object array is switched due to Java language limitations, but the exception always shows up AFTER the formatted message.

Parameters:

message - Message to be formatted.

throwable - Throwable to be logged.

parameters - Parameters to format the message.