com.persistit.logging

Interface PersistitLogMessage.LogItem

Enclosing class:

PersistitLogMessage

public static interface PersistitLogMessage.LogItem

Interface for a loggable item. Each location in the Persistit code base that potentially emits a log message uses an instance of LogItem. LogItem implementations may do (a) nothing, or (b) call a logging framework to emit the log message. This decision is made by the configure(PersistitLogger, PersistitLevel, String) method which is called each time the logging framework is set up or changed.

Method Summary

Modifier and Type	Method and Description
void	configure(PersistitLogger logger, PersistitLevel level, String message) Modify this LogItem to use the supplied PersistitLogger.
PersistitLevel	getLevel()
boolean	isEnabled()
void	log(Object... args) Emit a log message, or do nothing if this LogItem is disabled.
String	logMessage(Object... args) Construct a log message consisting of this LogItem's template combined with values in the supplied argument list.
void	logRecurring(int count, long duration, Object... args) Emit a log message for a recurring event, or do nothing if this LogItem is disabled.

Method Detail

isEnabled

boolean isEnabled()

Returns:

whether this log item is currently enabled for logging.

logMessage

String logMessage(Object... args)

Construct a log message consisting of this LogItem's template combined with values in the supplied argument list.

Parameters:

args - array of argument values that will be substituted into the log message

Returns:

the message as a string

log

void log(Object... args)

Emit a log message, or do nothing if this LogItem is disabled.

Parameters:

args - array of argument values that will be substituted into the log message

logRecurring

void logRecurring(int count,
                  long duration,
                  Object... args)

Emit a log message for a recurring event, or do nothing if this LogItem is disabled.

Parameters:

count - number of occurrences

duration - period of time in duration array of argument values that will be substituted into the log message

getLevel

PersistitLevel getLevel()

Returns:

This LogItem's log level, one of TRACE, DEBUG, INFO, WARN or ERROR

configure

void configure(PersistitLogger logger,
               PersistitLevel level,
               String message)

Modify this LogItem to use the supplied PersistitLogger. If the logger enables logging for messages having the supplied level then configure this LogItem to emit log messages; else configure it to do nothing, causing the JIT to compile away all instructions for log(Object...) method.

Parameters:

logger - The PersistitLogger that emits log messages

level - The PersistitLevel of this item

message - A message template which forms the basis of the log message