com.github.triceo.splitlog.api

Interface Message

All Superinterfaces:

Comparable<Message>

public interface Message
extends Comparable<Message>

A set of lines from the watched file, that is likely to constitute a single log message. No two messages are allowed to be equal, unless they have the same getUniqueId(). Messages will be comparable by getUniqueId() in the natural order.

Method Summary

Modifier and Type	Method and Description
Date	getDate() Get the date that this message was logged on.
ExceptionDescriptor	getExceptionDescriptor() Get data about exception included in this message.
List<String>	getLines() Get each line of the message.
List<String>	getLinesWithoutMetadata() Get each line of the message, with metadata stripped out.
String	getLogger() Will return the name of the logger that was used to write the log message.
Message	getPreviousMessage() Return a message that preceded this one in the same log stream.
MessageSeverity	getSeverity()
MessageType	getType()
long	getUniqueId() Unique ID of the message, that can be used to compare messages in the order of their arrival into this tool.
boolean	hasException()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDate

Date getDate()

Get the date that this message was logged on.

Returns:

Newly constructed instance of Date with the message log timestamp.

getExceptionDescriptor

ExceptionDescriptor getExceptionDescriptor()

Get data about exception included in this message.

Returns:

Exception data, if hasException() returns true. Null in any other case.

getLines

List<String> getLines()

Get each line of the message.

Returns:

Unmodifiable representation of lines in this message, exactly as were received.

getLinesWithoutMetadata

List<String> getLinesWithoutMetadata()

Get each line of the message, with metadata stripped out.

Returns:

Unmodifiable representation of text of the message.

getLogger

String getLogger()

Will return the name of the logger that was used to write the log message.

Returns:

Empty string if none found.

getPreviousMessage

Message getPreviousMessage()

Return a message that preceded this one in the same log stream.

Returns:

Null if there was no such message, the message already got GC'd, or getType() == MessageType.TAG.

getSeverity

MessageSeverity getSeverity()

getType

MessageType getType()

getUniqueId

long getUniqueId()

Unique ID of the message, that can be used to compare messages in the order of their arrival into this tool.

Returns:

ID of the message, guaranteed to be unique for every message, and increasing from message to message.

hasException

boolean hasException()