eu.beesoft.gaia.log
Interface Log

All Known Implementing Classes:

AbstractLog, ApacheLog, JavaLog, Log4jLog

public interface Log

This interface describes the methods for log implementation.

There are four logging levels:

• DEBUG
• INFO
• WARNING
• ERROR

For each level exist these methods:

• isLevelEnabled()
• level(String)
• level(String, Throwable)
• level(String, Object...)

where 'level' is used for one of 'debug', 'info', 'warn', 'error'.

Please note the last method: 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.

On the DEBUG level you can also use methods for logging of entering and exiting method.

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.
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.
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.
void	info(java.lang.String message, java.lang.Throwable exception) Logs an INFO message, if this level is enabled.
boolean	isDebugEnabled() Returns true if logging on level DEBUG is enabled.
boolean	isInfoEnabled() Returns true if logging on level INFO is enabled.
boolean	isWarnEnabled() Returns true if logging on level WARNING is enabled.
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.
void	warn(java.lang.String message, java.lang.Throwable exception) Logs a WARNING message, if this level is enabled.

Method Detail

isDebugEnabled

boolean isDebugEnabled()

Returns true if logging on level DEBUG is enabled.

Returns:

true if DEBUG is enabled

debug

void debug(java.lang.String message)

Logs a DEBUG message, if this level is enabled.

Parameters:

message - - message to log

debug

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

Logs a DEBUG message, if this level is enabled.

Parameters:

message - - message to log

exception - - exception to log

debug

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

Logs a DEBUG message, if this level is enabled.

Parameters:

message - - message to log

parameters - - parameters to merge with given message

entering

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

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

Parameters:

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

methodName - - a name of a method

entering

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.

Parameters:

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

methodName - - a name of a method

arguments - - arguments given to entered method

exiting

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

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

Parameters:

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

methodName - - a name of a method

exiting

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.

Parameters:

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

methodName - - a name of a method

returnValue - - value returned from a method

isInfoEnabled

boolean isInfoEnabled()

Returns true if logging on level INFO is enabled.

Returns:

true if INFO is enabled

info

void info(java.lang.String message)

Logs an INFO message, if this level is enabled.

Parameters:

message - - message to log

info

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

Logs an INFO message, if this level is enabled.

Parameters:

message - - message to log

exception - - exception to log

info

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

Logs an INFO message, if this level is enabled.

Parameters:

message - - message to log

parameters - - parameters to merge with given message

isWarnEnabled

boolean isWarnEnabled()

Returns true if logging on level WARNING is enabled.

Returns:

true if WARNING is enabled

warn

void warn(java.lang.String message)

Logs a WARNING message, if this level is enabled.

Parameters:

message - - message to log

warn

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

Logs a WARNING message, if this level is enabled.

Parameters:

message - - message to log

exception - - exception to log

warn

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

Logs a WARNING message, if this level is enabled.

Parameters:

message - - message to log

parameters - - parameters to merge with given message

error

void error(java.lang.String message)

Logs an ERROR message, if this level is enabled.

Parameters:

message - - message to log

error

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

Logs an ERROR message, if this level is enabled.

Parameters:

message - - message to log

exception - - exception to log

error

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

Logs an ERROR message, if this level is enabled.

Parameters:

message - - message to log

parameters - - parameters to merge with given message