com.kdgregory.log4j.aws.internal.shared

Class LogMessage

java.lang.Object

com.kdgregory.log4j.aws.internal.shared.LogMessage

All Implemented Interfaces:

Comparable<LogMessage>

public class LogMessage
extends Object
implements Comparable<LogMessage>

Holder for an in-queue logging message. Each instance has a timestamp and the message, stored as both a string and UTF-8 encoded bytes.

Constructor Summary

Constructors

Constructor and Description
LogMessage(org.apache.log4j.spi.LoggingEvent event, org.apache.log4j.Layout layout) Constructs an instance from a Log4J event, using the specified layout.
LogMessage(long timestamp, String message) Constructs an instance from a simple string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LogMessage that) Compares instances based on their timestamp.
byte[]	getBytes() Returns the UTF-8 message bytes.
String	getMessage() Returns the original message string.
long	getTimestamp() Returns the timestamp of the original logging event.
int	size() Returns the size of the message after conversion to UTF-8.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogMessage

public LogMessage(long timestamp,
                  String message)

Constructs an instance from a simple string.

Throws:

RuntimeException - if UTF-8 encoding is not supported by the JVM (which should never happen).

LogMessage

public LogMessage(org.apache.log4j.spi.LoggingEvent event,
                  org.apache.log4j.Layout layout)

Constructs an instance from a Log4J event, using the specified layout.

Throws:

RuntimeException - if any error occurred during formatting or conversion. Will include any root cause other than UnsupportedEncodingException.

Method Detail

getTimestamp

public long getTimestamp()

Returns the timestamp of the original logging event.

size

public int size()

Returns the size of the message after conversion to UTF-8.

getMessage

public String getMessage()

Returns the original message string.

getBytes

public byte[] getBytes()

Returns the UTF-8 message bytes.

compareTo

public int compareTo(LogMessage that)

Compares instances based on their timestamp.

Note that an "equal" comparison is not consistent with equals(), which uses default instance equality. This is intentional: one the one hand, there's no reason to test equality for two instances; they should be considered opaque. On the other, we don't want the comparision to do more than it should: we're using a stable sort, and rely on that fact to order two messages with the same timestamp in the order they were passed to append().

Specified by:

compareTo in interface Comparable<LogMessage>