gov.lbl.netlogger

Class LogMessage

java.lang.Object

gov.lbl.netlogger.LogMessage

public class LogMessage
extends java.lang.Object

This class lets you easily construct a set of typed (name, value) pairs that formats itself as a CEDPS Best Practices log message.

Name and value pairs are added into the record with add() methods which, by virtue of returning the newly modified LogMessage instance, can be chained together. For example:

LogMessage message = new LogMessage("my.event").add("my int",3).add("my float",4.0);

The user can set the timestamp to something other than the time of the call by calling setTimeStamp{Millis,Nanos}() as part of the chain.

To format the message, call toString(). The output format is CEDPS "Best Practices" format.

Since the addition of the nanosecond timestamp (which is rounded down to microseconds, and no I don't want to discuss it), this class requires Java 1.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPENDER
static java.lang.String	DATE_KW
static java.lang.String	EVENT_KW
static java.lang.String	FAKE_DATE
static java.lang.String	LEVEL_KW

Constructor Summary

Constructors

Constructor and Description
LogMessage(java.lang.String eventName) Create a new LogMessage at the current time with a given event name.

Method Summary

Methods

Modifier and Type	Method and Description
LogMessage	add(java.lang.String key, double value) Add a double.
LogMessage	add(java.lang.String key, float value) Add a float.
LogMessage	add(java.lang.String key, int value) Add an int.
LogMessage	add(java.lang.String key, long value) Add a long.
LogMessage	add(java.lang.String key, java.lang.String value) Add a string.
LogMessage	setTimeStampMillis(long millis) Set the timestamp from milliseconds returned by System.currentTimeMillis().
LogMessage	setTimeStampNanos(long nano1) Set the timestamp from nanoseconds returned by System.nanoTime().
java.lang.String	toString() Format a message in CEDPS Best Practices format.

Methods inherited from class java.lang.Object

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

Field Detail

APPENDER

public static final java.lang.String APPENDER

See Also:

Constant Field Values

EVENT_KW

public static final java.lang.String EVENT_KW

See Also:

Constant Field Values

DATE_KW

public static final java.lang.String DATE_KW

See Also:

Constant Field Values

FAKE_DATE

public static final java.lang.String FAKE_DATE

See Also:

Constant Field Values

LEVEL_KW

public static final java.lang.String LEVEL_KW

See Also:

Constant Field Values

Constructor Detail

LogMessage

public LogMessage(java.lang.String eventName)

Create a new LogMessage at the current time with a given event name.

The timestamp is set at creation time, but can be changed later with setTimeStampMillis or setTimeStampNanos.

Parameters:

eventName - Name of this logging event.

See Also:

setTimeStampMillis(long), setTimeStampNanos(long)

Method Detail

add

public LogMessage add(java.lang.String key,
             java.lang.String value)

Add a string.

Returns:

Self-reference, so calls can be chained

add

public LogMessage add(java.lang.String key,
             int value)

Add an int.

Returns:

Self-reference, so calls can be chained

add

public LogMessage add(java.lang.String key,
             long value)

Add a long.

Returns:

Self-reference, so calls can be chained

add

public LogMessage add(java.lang.String key,
             float value)

Add a float.

Returns:

Self-reference, so calls can be chained

add

public LogMessage add(java.lang.String key,
             double value)

Add a double.

Returns:

Self-reference, so calls can be chained

setTimeStampMillis

public LogMessage setTimeStampMillis(long millis)

Set the timestamp from milliseconds returned by System.currentTimeMillis().

Returns:

'this' so we can chain

setTimeStampNanos

public LogMessage setTimeStampNanos(long nano1)

Set the timestamp from nanoseconds returned by System.nanoTime().

Returns:

'this' so we can chain

toString

public java.lang.String toString()

Format a message in CEDPS Best Practices format.

Overrides:

toString in class java.lang.Object

Returns:

Formatted message string

See Also:

CEDPS "Best Practices" format