edu.illinois.ncsa.daffodil.japi.logger

Class LogWriter

java.lang.Object

edu.illinois.ncsa.daffodil.japi.logger.LogWriter

Direct Known Subclasses:

ConsoleLogWriter, FileLogWriter, NullLogWriter

public abstract class LogWriter
extends java.lang.Object

Abstract log writer, which can be overridden to create a custom log writer.

Constructor Summary

Constructors

Constructor and Description
LogWriter()

Method Summary

Modifier and Type	Method and Description
void	log(LogLevel level, java.lang.String logID, java.lang.String msg, java.util.List<java.lang.Object> args) Generates a log message as a string and calls the write method.
protected java.lang.String	prefix(LogLevel level, java.lang.String logID) Override to change the prefix string of the log message.
protected java.lang.String	suffix(LogLevel level, java.lang.String logID) Override to change the suffix string of the log message.
protected abstract void	write(LogLevel level, java.lang.String logID, java.lang.String msg) Implement this method to determine how the log message is written.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogWriter

public LogWriter()

Method Detail

write

protected abstract void write(LogLevel level,
                              java.lang.String logID,
                              java.lang.String msg)

Implement this method to determine how the log message is written.

Parameters:

level - level of the message

logID - identification of class that created the log message

msg - log message

prefix

protected java.lang.String prefix(LogLevel level,
                                  java.lang.String logID)

Override to change the prefix string of the log message.

By default, the prefix is the empty string.

Parameters:

level - level of the message

logID - identification of class that created the log message

Returns:

the prefix to use for log messages. Defaults to the empty string if not overridden.

suffix

protected java.lang.String suffix(LogLevel level,
                                  java.lang.String logID)

Override to change the suffix string of the log message.

By default, the suffix is the empty string.

Parameters:

level - level of the message

logID - identification of class that created the log message

Returns:

the suffix to use for log messages. Defaults to the empty string if not overridden.

log

public void log(LogLevel level,
                java.lang.String logID,
                java.lang.String msg,
                java.util.List<java.lang.Object> args)

Generates a log message as a string and calls the write method.

The default implementation generates a log message based on the prefix, suffix, message string, and log arguments, and passes the generated log message, level, and logId to write(edu.illinois.ncsa.daffodil.japi.logger.LogLevel, java.lang.String, java.lang.String).

Can be overridden if more control is needed over the logging mechanism and/or log arguments are needed as separate entities.

Parameters:

level - level of the message

logID - identification of class that created the log message

msg - printf-style format string

args - arguments passed to the logger, matching the format string