Package de.uni_trier.wi2.procake.utils.logger

Interface Logger

All Known Implementing Classes:

SLF4JLogger, SomeLogger

public interface Logger

The Logger provides a unified method to log messages and to inform available log listeners. Each logger can only be used for one component. To get a logger the method LoggerFactory.getLogger(String) must be used where the component must be given as parameter.

Several methods are provided for logging. For all log methods a Level must be given that describes the importance of the message.

Author:

Rainer Maximini

See Also:

MessageFormatter

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT

Method Summary

Modifier and Type	Method	Description
void	addLoggerListener(LoggerListener listener)	Adds a log listener to the collection of listeners.
void	log(Level level, CakeException exception)	Logs a CAKE exception.
void	log(Level level, String message)	Can be used to log a message directly.
void	log(Level level, String key, Exception exception)	Logs an exception.
void	log(Level level, String key, Object caller)
void	log(Level level, String key, Object caller, Object parameter1)
void	log(Level level, String key, Object caller, Object[] parameters)
void	log(Level level, String key, Object caller, Object parameter1, Object parameter2)
void	log(Level level, String key, Object caller, Object parameter1, Object parameter2, Object parameter3)
void	removeLoggerListener(LoggerListener listener)	Remove a log listener from the collection of listeners.

Field Detail

COMPONENT

static final String COMPONENT

See Also:

Constant Field Values

Method Detail

addLoggerListener

void addLoggerListener(LoggerListener listener)

Adds a log listener to the collection of listeners. If the listener is already in the collection nothing will happen. Each listener will only be listen on the events for this component.

Parameters:

listener - A new log listener.

log

void log(Level level,
         CakeException exception)

Logs a CAKE exception. The CAKE exception containing all necessary information thus this exceptions can be loged directly. The exception already contains a component which can be different to the one of the logger. In such situations, the logger automatically forwards the exception to the log methods of the logger with the same component.

Parameters:

level - The log level.

exception - The exception to be logged.

log

void log(Level level,
         String message)

Can be used to log a message directly.

Parameters:

level - The log level.

message - The message that should be logged

log

void log(Level level,
         String key,
         Exception exception)

Logs an exception.

Parameters:

level - The log level.

key - The log key.

exception -

log

void log(Level level,
         String key,
         Object caller)

Parameters:

level - The log level.

key - The log key.

caller -

log

void log(Level level,
         String key,
         Object caller,
         Object parameter1)

Parameters:

level - The log level.

key - The log key.

caller - The caller of the log method.

parameter1 -

log

void log(Level level,
         String key,
         Object caller,
         Object parameter1,
         Object parameter2)

Parameters:

level - The log level.

key - The log key.

caller - The caller of the log method.

parameter1 -

parameter2 -

log

void log(Level level,
         String key,
         Object caller,
         Object parameter1,
         Object parameter2,
         Object parameter3)

Parameters:

level - The log level.

key - The log key.

caller - The caller of the log method.

parameter1 -

parameter2 -

parameter3 -

log

void log(Level level,
         String key,
         Object caller,
         Object[] parameters)

Parameters:

level - The log level.

key - The log key.

caller - The caller of the log method.

parameters -

removeLoggerListener

void removeLoggerListener(LoggerListener listener)

Remove a log listener from the collection of listeners. If the listener is not in the collection nothing will happen.

Parameters:

listener - The log listener to be removed.