org.wattdepot.common.util.logger

Class OneLineFormatter

java.lang.Object

java.util.logging.Formatter

org.wattdepot.common.util.logger.OneLineFormatter

public class OneLineFormatter
extends Formatter

Provides a one line formatter for use with WattDepot logging. Supports optional date stamp prefix and optional appending of a newline. Portions of this code are adapted from http://hackystat-utilities.googlecode.com/

Author:

Philip Johnson, Robert Brewer

Constructor Summary

Constructors

Constructor and Description
OneLineFormatter() Default constructor that enables the date stamp and new line.
OneLineFormatter(boolean enableDateStamp) One line format string with optional date stamp.
OneLineFormatter(boolean enableDateStamp, boolean enableNewline) One line format string with optional date stamp and optional newline.

Method Summary

Methods

Modifier and Type	Method and Description
String	format(LogRecord record) Formats the passed log string as a single line.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Detail

OneLineFormatter

public OneLineFormatter()

Default constructor that enables the date stamp and new line.

OneLineFormatter

public OneLineFormatter(boolean enableDateStamp)

One line format string with optional date stamp. Always adds a newline.

Parameters:

enableDateStamp - If true, a date stamp is inserted.

OneLineFormatter

public OneLineFormatter(boolean enableDateStamp,
                boolean enableNewline)

One line format string with optional date stamp and optional newline.

Parameters:

enableDateStamp - If true, a date stamp is inserted.

enableNewline - If true, a newline is always inserted.

Method Detail

format

public String format(LogRecord record)

Formats the passed log string as a single line. Prefixes the log string with a date stamp if enabled, and adds a newline if enabled.

Specified by:

format in class Formatter

Parameters:

record - A log record.

Returns:

The message string.