org.arakhne.logging
Class LoggingSystem

java.lang.Object
  org.arakhne.logging.LoggingSystem

public class LoggingSystem
extends Object

This interface describes the body of an situated agent. The body is the only available interaction mean between an agent and the environment.

Version:

1.7 (rev:285) 2011-10-14 12:02:59

Author:

Stéphane GALLAND, Nicolas GAUD

Maven Group Id:

org.arakhne.afc

Maven Artifact Id:

arakhneLogger

Constructor Summary

protected

LoggingSystem()

Method Summary

void	addLoggerEventListener(LoggerEventListener listener) Add listener on logger events.
protected Logger	createLoggerInstance(String name, LogLevel minLogLevel)
protected Class<? extends Logger>	findDefaultLoggerClass()
protected Class<? extends Logger>	findLoggerClass()
(package private) void	fireLoggerEvent(LoggerEvent event) Notify the logger event listeners.
Logger	getAnonymousLogger() Replies the logger to use when the scope is unknown.
LogLevel	getDefaultLogLevel() Replies the default log level for new loggers.
static Logger	getLogger() Return an anonymous logger.
static Logger	getLogger(Class<?> clazz) Return a logger named corresponding to the class passed as parameter.
static Logger	getLogger(String name) Return a logger named according to the name parameter.
static LoggingSystem	getLoggingSystem() Returns the instance of LoggingSystem in use
Logger	getPreferedLogger(String scopeName) Replies the prefered logger for the specified scope.
Class<? extends Logger>	getPreferedLoggerType() Replies the prefered type for the loggers.
void	removeLoggerEventListener(LoggerEventListener listener) Remove listener on logger events.
void	setDefaultLogLevel(LogLevel logLevel) Set the default log level for new loggers.
void	setPreferedLogger(String scopeName, Logger logger) Set the prefered logger.
void	setPreferedLoggerType(Class<? extends Logger> type) Set the prefered type for the loggers.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingSystem

protected LoggingSystem()

Method Detail

getLogger

public static Logger getLogger()

Return an anonymous logger.

Returns:

logger

getLogger

public static Logger getLogger(String name)

Return a logger named according to the name parameter.

Parameters:

name - - The name of the logger.

Returns:

logger

getLogger

public static Logger getLogger(Class<?> clazz)

Return a logger named corresponding to the class passed as parameter.

Parameters:

clazz - - the returned logger will be named after clazz

Returns:

logger

getLoggingSystem

public static LoggingSystem getLoggingSystem()

Returns the instance of LoggingSystem in use

Returns:

the instance of LoggingSystem in use

setDefaultLogLevel

public void setDefaultLogLevel(LogLevel logLevel)

Set the default log level for new loggers.

Parameters:

logLevel -

getDefaultLogLevel

public LogLevel getDefaultLogLevel()

Replies the default log level for new loggers.

Returns:

the default log level, never null

setPreferedLoggerType

public void setPreferedLoggerType(Class<? extends Logger> type)

Set the prefered type for the loggers.

Parameters:

type - is the prefered type or null to use the system default.

getPreferedLoggerType

public Class<? extends Logger> getPreferedLoggerType()

Replies the prefered type for the loggers.

Returns:

the type of null to use the system default.

setPreferedLogger

public void setPreferedLogger(String scopeName,
                              Logger logger)

Set the prefered logger.

Parameters:

scopeName - is the name of the scope for the new prefered logger.

logger - msut be a reference to the new prefered logger or null to use the default logger.

getPreferedLogger

public Logger getPreferedLogger(String scopeName)

Replies the prefered logger for the specified scope.

Parameters:

scopeName - is the name of the logger scope.

Returns:

the logger.

getAnonymousLogger

public Logger getAnonymousLogger()

Replies the logger to use when the scope is unknown.

Returns:

the anonymous logger.

createLoggerInstance

protected Logger createLoggerInstance(String name,
                                      LogLevel minLogLevel)

Parameters:

name - is the scope of the logger to create.

minLogLevel - is the minimal log level of the new logger.

Returns:

the created logged.

findLoggerClass

protected final Class<? extends Logger> findLoggerClass()

Returns:

the type of the the preferred logging system.

findDefaultLoggerClass

protected Class<? extends Logger> findDefaultLoggerClass()

Returns:

the type of the the preferred logging system.

addLoggerEventListener

public final void addLoggerEventListener(LoggerEventListener listener)

Add listener on logger events.

Parameters:

listener -

removeLoggerEventListener

public void removeLoggerEventListener(LoggerEventListener listener)

Remove listener on logger events.

Parameters:

listener -

fireLoggerEvent

final void fireLoggerEvent(LoggerEvent event)

Notify the logger event listeners.

Parameters:

event -