org.usefultoys.slf4j.internal

Class EventData

java.lang.Object

org.usefultoys.slf4j.internal.EventData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SystemData

public abstract class EventData
extends Object
implements Serializable

Abstract class representing events collected by slf4j-toys.

Author:

Daniel Felix Ferber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_POSITION
static String	EVENT_TIME
protected long	position Time ordered position for multiple occurrences of the same event.
static String	SESSION_UUID
protected String	sessionUuid Session UUID of JVM where this event data was collected.
protected long	time Timestamp when the event data was collected.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventData()
protected	EventData(String sessionUuid)
protected	EventData(String sessionUuid, long position)
protected	EventData(String sessionUuid, long position, long time)

Method Summary

Modifier and Type	Method and Description
String	encodedMessage()
String	json5Message()
String	readableMessage()
protected abstract StringBuilder	readableStringBuilder(StringBuilder builder) Writes a concise, human readable string representation of the event into the supplied StringBuilder.
void	readJson5(String json5)
protected void	reset() Reverts all event attributes to their constructor initial value.
protected void	resetImpl() Subclasses shall provide an implementation that resets its specific properties to their constructor initial value.
protected StringBuilder	writeJson5(StringBuilder sb) Writes a JSON encoded representation of the event into the supplied StringBuilder.
protected void	writeJson5Impl(StringBuilder sb)

Methods inherited from class java.lang.Object

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

Field Detail

sessionUuid

protected String sessionUuid

Session UUID of JVM where this event data was collected.

position

protected long position

Time ordered position for multiple occurrences of the same event.

time

protected long time

Timestamp when the event data was collected.

SESSION_UUID

public static final String SESSION_UUID

See Also:

Constant Field Values

EVENT_POSITION

public static final String EVENT_POSITION

See Also:

Constant Field Values

EVENT_TIME

public static final String EVENT_TIME

See Also:

Constant Field Values

Constructor Detail

EventData

protected EventData()

EventData

protected EventData(String sessionUuid)

EventData

protected EventData(String sessionUuid,
                    long position)

EventData

protected EventData(String sessionUuid,
                    long position,
                    long time)

Method Detail

reset

protected final void reset()

Reverts all event attributes to their constructor initial value. Useful to reuse the event instance and avoid creation of new objects.

resetImpl

protected void resetImpl()

Subclasses shall provide an implementation that resets its specific properties to their constructor initial value. This method is called once and shall compare all specific properties.

readableStringBuilder

protected abstract StringBuilder readableStringBuilder(StringBuilder builder)

Writes a concise, human readable string representation of the event into the supplied StringBuilder.

Parameters:

builder - The StringBuilder that receives the string representation

Returns:

The StringBuilder passed as argument to allow chained StringBuilder method calls.

readableMessage

public final String readableMessage()

writeJson5

protected final StringBuilder writeJson5(StringBuilder sb)

Writes a JSON encoded representation of the event into the supplied StringBuilder.

Parameters:

sb - The StringBuilder that receives the encoded representation.

Returns:

The StringBuilder passed as argument to allow chained StringBuilder method calls.

writeJson5Impl

protected void writeJson5Impl(StringBuilder sb)

json5Message

public final String json5Message()

readJson5

public void readJson5(String json5)

encodedMessage

public final String encodedMessage()