com.kdgregory.logging.common

Class LogMessage

java.lang.Object

com.kdgregory.logging.common.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 a message body. The latter is held both as a string and as UTF-8 encoded bytes.

Constructor Summary

Constructors

Constructor and Description
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.
int	size() Returns the size of the UTF-8 representation.
void	truncate(int maxSize) Ensures that the message has no more than the specified number of bytes, truncating if necessary.

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.

Method Detail

getTimestamp

public long getTimestamp()

Returns the timestamp.

size

public int size()

Returns the size of the UTF-8 representation.

getMessage

public String getMessage()

Returns the original message string.

getBytes

public byte[] getBytes()

Returns the UTF-8 message bytes.

truncate

public void truncate(int maxSize)

Ensures that the message has no more than the specified number of bytes, truncating if necessary. This is a "semi-smart" truncate, in that it won't break UTF-8 character sequences, but it isn't smart enough to recognize Unicode code points that consist of multiple UTF-8 sequences. It also assumes that it will be given valid UTF-8, with indeterminate results if not.

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>