eu.beesoft.gaia.log
Class AbstractLog

java.lang.Object
  eu.beesoft.gaia.log.AbstractLog

All Implemented Interfaces:

Log

Direct Known Subclasses:

ApacheLog, JavaLog, Log4jLog

public abstract class AbstractLog
extends java.lang.Object
implements Log

The base implementation of Log interface.

All methods left to implementation in subclasses are:

• isDebugEnabled()
• debug(String, Throwable)
• isInfoEnabled()
• info(String, Throwable)
• isWarnEnabled()
• warn(String, Throwable)
• error(String, Throwable)

Please note there are implemented methods with variable arguments count: you can use it to merge any number of parameters to logged message. In these methods is each character pair {} replaced by one of the given parameters. For example you can log:

 info ("Current array index is {} of {}", 2, 5);
 

and logged message is Current array index is 2 of 5.

Constructor Summary

AbstractLog()

Method Summary

void	debug(java.lang.String message) Logs a DEBUG message, if this level is enabled.
void	debug(java.lang.String message, java.lang.Object... parameters) Logs a DEBUG message, if this level is enabled.
abstract void	debug(java.lang.String message, java.lang.Throwable exception) Logs a DEBUG message, if this level is enabled.
void	entering(java.lang.String className, java.lang.String methodName) Logs a DEBUG message about entering a method, if this level is enabled.
void	entering(java.lang.String className, java.lang.String methodName, java.lang.Object... arguments) Logs a DEBUG message about entering a method, if this level is enabled.
void	error(java.lang.String message) Logs an ERROR message, if this level is enabled.
void	error(java.lang.String message, java.lang.Object... parameters) Logs an ERROR message, if this level is enabled.
abstract void	error(java.lang.String message, java.lang.Throwable exception) Logs an ERROR message, if this level is enabled.
void	exiting(java.lang.String className, java.lang.String methodName) Logs a DEBUG message about exiting a method, if this level is enabled.
void	exiting(java.lang.String className, java.lang.String methodName, java.lang.Object returnValue) Logs a DEBUG message about exiting a method, if this level is enabled.
void	info(java.lang.String message) Logs an INFO message, if this level is enabled.
void	info(java.lang.String message, java.lang.Object... parameters) Logs an INFO message, if this level is enabled.
abstract void	info(java.lang.String message, java.lang.Throwable exception) Logs an INFO message, if this level is enabled.
abstract boolean	isDebugEnabled() Returns true if logging on level DEBUG is enabled.
abstract boolean	isInfoEnabled() Returns true if logging on level INFO is enabled.
abstract boolean	isWarnEnabled() Returns true if logging on level WARNING is enabled.
protected java.lang.String	mergeMessageWithParameters(java.lang.String message, java.lang.Object[] parameters) Merges given message with given parameters.
protected java.lang.String	toString(java.lang.Object object) Converts object to String, supports null values.
void	warn(java.lang.String message) Logs a WARNING message, if this level is enabled.
void	warn(java.lang.String message, java.lang.Object... parameters) Logs a WARNING message, if this level is enabled.
abstract void	warn(java.lang.String message, java.lang.Throwable exception) Logs a WARNING message, if this level is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLog

public AbstractLog()

Method Detail

isDebugEnabled

public abstract boolean isDebugEnabled()

Description copied from interface: Log

Returns true if logging on level DEBUG is enabled.

Specified by:

isDebugEnabled in interface Log

Returns:

true if DEBUG is enabled

debug

public void debug(java.lang.String message)

Description copied from interface: Log

Logs a DEBUG message, if this level is enabled.

Specified by:

debug in interface Log

Parameters:

message - - message to log

debug

public abstract void debug(java.lang.String message,
                           java.lang.Throwable exception)

Description copied from interface: Log

Logs a DEBUG message, if this level is enabled.

Specified by:

debug in interface Log

Parameters:

message - - message to log

exception - - exception to log

debug

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

Description copied from interface: Log

Logs a DEBUG message, if this level is enabled.

Specified by:

debug in interface Log

Parameters:

message - - message to log

parameters - - parameters to merge with given message

entering

public void entering(java.lang.String className,
                     java.lang.String methodName)

Description copied from interface: Log

Logs a DEBUG message about entering a method, if this level is enabled.

Specified by:

entering in interface Log

Parameters:

className - - a name of class where is a method implemented

methodName - - a name of a method

entering

public void entering(java.lang.String className,
                     java.lang.String methodName,
                     java.lang.Object... arguments)

Description copied from interface: Log

Logs a DEBUG message about entering a method, if this level is enabled.

Specified by:

entering in interface Log

Parameters:

className - - a name of class where is a method implemented

methodName - - a name of a method

arguments - - arguments given to entered method

exiting

public void exiting(java.lang.String className,
                    java.lang.String methodName)

Description copied from interface: Log

Logs a DEBUG message about exiting a method, if this level is enabled.

Specified by:

exiting in interface Log

Parameters:

className - - a name of class where is a method implemented

methodName - - a name of a method

exiting

public void exiting(java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Object returnValue)

Description copied from interface: Log

Logs a DEBUG message about exiting a method, if this level is enabled.

Specified by:

exiting in interface Log

Parameters:

className - - a name of class where is a method implemented

methodName - - a name of a method

returnValue - - value returned from a method

isInfoEnabled

public abstract boolean isInfoEnabled()

Description copied from interface: Log

Returns true if logging on level INFO is enabled.

Specified by:

isInfoEnabled in interface Log

Returns:

true if INFO is enabled

info

public void info(java.lang.String message)

Description copied from interface: Log

Logs an INFO message, if this level is enabled.

Specified by:

info in interface Log

Parameters:

message - - message to log

info

public abstract void info(java.lang.String message,
                          java.lang.Throwable exception)

Description copied from interface: Log

Logs an INFO message, if this level is enabled.

Specified by:

info in interface Log

Parameters:

message - - message to log

exception - - exception to log

info

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

Description copied from interface: Log

Logs an INFO message, if this level is enabled.

Specified by:

info in interface Log

Parameters:

message - - message to log

parameters - - parameters to merge with given message

isWarnEnabled

public abstract boolean isWarnEnabled()

Description copied from interface: Log

Returns true if logging on level WARNING is enabled.

Specified by:

isWarnEnabled in interface Log

Returns:

true if WARNING is enabled

warn

public void warn(java.lang.String message)

Description copied from interface: Log

Logs a WARNING message, if this level is enabled.

Specified by:

warn in interface Log

Parameters:

message - - message to log

warn

public abstract void warn(java.lang.String message,
                          java.lang.Throwable exception)

Description copied from interface: Log

Logs a WARNING message, if this level is enabled.

Specified by:

warn in interface Log

Parameters:

message - - message to log

exception - - exception to log

warn

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

Description copied from interface: Log

Logs a WARNING message, if this level is enabled.

Specified by:

warn in interface Log

Parameters:

message - - message to log

parameters - - parameters to merge with given message

error

public void error(java.lang.String message)

Description copied from interface: Log

Logs an ERROR message, if this level is enabled.

Specified by:

error in interface Log

Parameters:

message - - message to log

error

public abstract void error(java.lang.String message,
                           java.lang.Throwable exception)

Description copied from interface: Log

Logs an ERROR message, if this level is enabled.

Specified by:

error in interface Log

Parameters:

message - - message to log

exception - - exception to log

error

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

Description copied from interface: Log

Logs an ERROR message, if this level is enabled.

Specified by:

error in interface Log

Parameters:

message - - message to log

parameters - - parameters to merge with given message

mergeMessageWithParameters

protected java.lang.String mergeMessageWithParameters(java.lang.String message,
                                                      java.lang.Object[] parameters)

Merges given message with given parameters.

Parameters:

message -

toString

protected java.lang.String toString(java.lang.Object object)

Converts object to String, supports null values.

Parameters:

object - - object to convert

Returns:

string value of object