jsimple.logging.helpers

Class NOPLogger

java.lang.Object

jsimple.logging.Logger

jsimple.logging.helpers.NOPLogger

public class NOPLogger
extends Logger

A direct NOP (no operation) implementation of Logger.

Field Summary

Fields

Modifier and Type	Field and Description
static NOPLogger	NOP_LOGGER The unique instance of NOPLogger.

Fields inherited from class jsimple.logging.Logger

ROOT_LOGGER_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NOPLogger() There is no point in creating multiple instances of NOPLOgger, except by derived classes, hence the protected access for the constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Always returns the string value "NOP".
boolean	isLevelEnabled(Level level) For this logger, don't log anything.
void	log(Level level, java.lang.String msg, java.lang.Throwable t) Log an exception (throwable) at the specified level with an accompanying message.
LogEnterLeave	logStartAndEndWithVarargs(Level level, java.lang.String format, java.lang.Object... arguments) Log start and end messages at the specified level, with the specified message format and arguments.
void	logWithVarargs(Level level, java.lang.String format, java.lang.Object... arguments) Log a message at the specified level, with the specified message format and arguments.
void	setLevel(Level level) Set the level for this logger.

Methods inherited from class jsimple.logging.Logger

debug, debug, debug, debug, debug, debugEnterLeave, debugEnterLeave, error, error, error, error, error, info, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, log, log, log, log, logEnterLeave, trace, trace, trace, trace, trace, traceEnterLeave, traceEnterLeave, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

NOP_LOGGER

public static final NOPLogger NOP_LOGGER

The unique instance of NOPLogger.

Constructor Detail

NOPLogger

protected NOPLogger()

There is no point in creating multiple instances of NOPLOgger, except by derived classes, hence the protected access for the constructor.

Method Detail

getName

public java.lang.String getName()

Always returns the string value "NOP".

Specified by:

getName in class Logger

Returns:

name of this logger instance

isLevelEnabled

public boolean isLevelEnabled(Level level)

For this logger, don't log anything.

Specified by:

isLevelEnabled in class Logger

Parameters:

level - log level

Returns:

whether logging should be enabled; the NOPLogger always returns false here

setLevel

public void setLevel(Level level)

Description copied from class: Logger

Set the level for this logger. The logger implementation is free to define the exact semantics of changing the level--what other loggers may be affected (if there's some kind of hierarchy), etc.

Specified by:

setLevel in class Logger

Parameters:

level - new level

logWithVarargs

public void logWithVarargs(Level level,
                           java.lang.String format,
                           java.lang.Object... arguments)

Description copied from class: Logger

Log a message at the specified level, with the specified message format and arguments. This method is the same as the log varargs method, except that it has a different name, with no overloads, to force use of the varargs version no matter how few arguments are passed.

Specified by:

logWithVarargs in class Logger

Parameters:

level - logging level to log at

format - the format string

arguments - a list of 0 or more arguments

log

public void log(Level level,
                java.lang.String msg,
                java.lang.Throwable t)

Description copied from class: Logger

Log an exception (throwable) at the specified level with an accompanying message.

Specified by:

log in class Logger

Parameters:

level - logging level to log at

msg - the message accompanying the exception

t - the exception (throwable) to log

logStartAndEndWithVarargs

public LogEnterLeave logStartAndEndWithVarargs(Level level,
                                               java.lang.String format,
                                               java.lang.Object... arguments)

Description copied from class: Logger

Log start and end messages at the specified level, with the specified message format and arguments. This method is the same as the logEnterLeave varargs method, except that it has a different name, with no overloads, to force use of the varargs version no matter how few arguments are passed.

Specified by:

logStartAndEndWithVarargs in class Logger

Parameters:

level - logging level to log at

format - the format string

arguments - a list of 0 or more arguments