com.eclecticlogic.whisper.spi

Interface Message<E>

All Known Implementing Classes:

AbstractMessage, LogbackMessage

public interface Message<E>

Every logging implementation's message needs to expose this interface. This is done by wrapping the message in a wrapper that implements this interface (and uses AbstractMessage as a convenient base class).

Author:

Karthik Abram

Method Summary

Modifier and Type	Method and Description
String	getCanonicalMessage()
E	getEvent()
String	getFullMessage()
String	getMessage()
long	getMessageAge()
long	getMessageTime()

Method Detail

getMessageAge

long getMessageAge()

Returns:

How long ago (in milliseconds) this message was logged.

getMessageTime

long getMessageTime()

Returns:

Timestamp of this message in milliseconds since epoch.

getCanonicalMessage

String getCanonicalMessage()

Returns:

Message string without parameters (if the underlying logging implementation allows for this).

getEvent

E getEvent()

Returns:

Underlying implementation specific message class.

getMessage

String getMessage()

Returns:

Formatted message (for exceptions, this does not include stack trace).

getFullMessage

String getFullMessage()

Returns:

The fully formatted message (for exceptions, this includes call stack).