org.jlog2

Class Logger

java.lang.Object

org.jlog2.Logger

public class Logger
extends java.lang.Object

This class stores log channels appropriate for each Logger instance and provides the methods to log messages to those channels.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
Logger(java.lang.String thisLoggerID) Create a new instance of Logger.
Logger(java.lang.String thisLoggerID, java.lang.String thisClassName) Create a new instance of Logger.

Method Summary

Modifier and Type	Method and Description
protected boolean	canDebug(java.lang.String messageLevel) Return true if the logger can debug to the specified level.
protected boolean	canLog(java.lang.String messageLevel) Return true if the logger can log to the specified level.
void	debugError(java.lang.String level, java.lang.String message) Debug the error on the appropriate channels.
void	debugError(java.lang.String level, java.lang.Throwable error) Debug the error on the appropriate channels.
void	debugMessage(java.lang.String level, java.lang.String methodName, java.lang.String message) Debug the message on the appropriate channels.
boolean	getDebug() Get the value indicating if the debug channels are being used.
java.lang.String	getLoggerID() Get the unique id that created this logger.
boolean	isDebugEnabled() Return true if the logger is set to debug.
boolean	isErrorEnabled() Return true if the logger can log to the error level.
boolean	isInfoEnabled() Return true if the logger can log to the info level.
boolean	isWarnEnabled() Return true if the logger can log to the warn level.
void	logError(java.lang.String level, java.lang.String message, java.lang.Throwable error) Log the error on the appropriate channels.
void	logError(java.lang.String level, java.lang.Throwable error) Log the error on the appropriate channels.
void	logMessage(java.lang.String level, java.lang.String message) Log the message on the appropriate channels.
void	logMessage(java.lang.String level, java.lang.String methodName, java.lang.String message) Log the message on the appropriate channels.
void	setDebug(boolean thisDebug) Set a value indicating if the debug channels should be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logger

public Logger(java.lang.String thisLoggerID)

Create a new instance of Logger.

Parameters:

thisLoggerID - the unique logger id.

Logger

public Logger(java.lang.String thisLoggerID,
              java.lang.String thisClassName)

Create a new instance of Logger.

Parameters:

thisLoggerID - the unique logger id.

thisClassName - the class name of the class that uses this logger if different from the logger id.

Method Detail

setDebug

public void setDebug(boolean thisDebug)

Set a value indicating if the debug channels should be used.

Parameters:

thisDebug - true if log a debug trace, false otherwise.

getDebug

public boolean getDebug()

Get the value indicating if the debug channels are being used.

Returns:

the value of debug.

getLoggerID

public java.lang.String getLoggerID()

Get the unique id that created this logger.

Returns:

the value of loggerID.

logMessage

public void logMessage(java.lang.String level,
                       java.lang.String message)

Log the message on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

message - the message to log.

logMessage

public void logMessage(java.lang.String level,
                       java.lang.String methodName,
                       java.lang.String message)

Log the message on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

methodName - the name of the method in the class logging the message.

message - the message to log.

debugMessage

public void debugMessage(java.lang.String level,
                         java.lang.String methodName,
                         java.lang.String message)

Debug the message on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

methodName - the name of the method in the class logging the message.

message - the message to log.

logError

public void logError(java.lang.String level,
                     java.lang.Throwable error)

Log the error on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

error - the error to log.

logError

public void logError(java.lang.String level,
                     java.lang.String message,
                     java.lang.Throwable error)

Log the error on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

message - an additional message.

error - the error to log.

debugError

public void debugError(java.lang.String level,
                       java.lang.Throwable error)

Debug the error on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

error - the error to debug.

debugError

public void debugError(java.lang.String level,
                       java.lang.String message)

Debug the error on the appropriate channels.

Parameters:

level - the log level for the message, error, warning, etc.

message - the debug message to log.

canLog

protected boolean canLog(java.lang.String messageLevel)

Return true if the logger can log to the specified level.

Parameters:

messageLevel - the level to log to.

Returns:

true if can log at this level.

canDebug

protected boolean canDebug(java.lang.String messageLevel)

Return true if the logger can debug to the specified level.

Parameters:

messageLevel - the level to log to.

Returns:

true if can log at this level.

isErrorEnabled

public boolean isErrorEnabled()

Return true if the logger can log to the error level.

Returns:

true if can log to the error level.

isWarnEnabled

public boolean isWarnEnabled()

Return true if the logger can log to the warn level.

Returns:

true if can log to the warn level.

isInfoEnabled

public boolean isInfoEnabled()

Return true if the logger can log to the info level.

Returns:

true if can log to the info level.

isDebugEnabled

public boolean isDebugEnabled()

Return true if the logger is set to debug.

Returns:

true if debug is true.