org.usefultoys.slf4j.internal

Class EventData

java.lang.Object

org.usefultoys.slf4j.internal.EventData

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SystemData

public abstract class EventData
extends java.lang.Object
implements java.io.Serializable

Abstract class representing events collected by slf4j-toys.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	EVENT_CATEGORY
protected static java.lang.String	EVENT_NAME
protected static java.lang.String	EVENT_POSITION
protected java.lang.String	eventCategory Identifier that categorizes events.
protected java.lang.String	eventName Identifier of the event.
protected long	eventPosition Time ordered position for multiple occurrences of the same event.
protected static java.lang.String	SESSION_UUID
protected java.lang.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()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEventCategory()
java.lang.String	getEventName()
long	getEventPosition()
java.lang.String	getFullID()
java.lang.String	getSessionUuid()
long	getTime()
int	hashCode()
protected abstract boolean	isCompletelyEqualsImpl(EventData other) Subclasses shall provide an implementation that compares its specific properties to the respective properties of the other instance given as argument.
boolean	isCompletelyEqualsTo(EventData other) Indicates weather all properties are equal to the respective properties of the other instance given as argument.
boolean	isSameAs(EventData other) Indicates whether this event represents the same as the given argument, based on session uuid, category, name and position.
protected boolean	read(java.lang.String message, char messagePrefix) Reads an event from the encoded string representation.
abstract java.lang.StringBuilder	readableString(java.lang.StringBuilder builder) Writes a concise, human readable string representation of the event into the supplied StringBuilder.
protected abstract boolean	readPropertyImpl(EventReader reader, java.lang.String key) Subclasses shall provide an implementation that reads its specific properties from the encoded string representation.
protected void	reset() Reverts all event attributes to their constructor initial value.
protected abstract void	resetImpl() Subclasses shall provide an implementation that resets its specific properties to their constructor initial value.
java.lang.String	toString()
java.lang.StringBuilder	write(java.lang.StringBuilder sb, char messagePrefix) Writes an encoded string representation of the event into the supplied StringBuilder.
protected abstract void	writePropertiesImpl(EventWriter w) Subclasses shall provide an implementation that appends its specific properties to the encoded string representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sessionUuid

protected java.lang.String sessionUuid

Session UUID of JVM where this event data was collected.

eventCategory

protected java.lang.String eventCategory

Identifier that categorizes events.

eventName

protected java.lang.String eventName

Identifier of the event.

eventPosition

protected long eventPosition

Time ordered position for multiple occurrences of the same event.

time

protected long time

Timestamp when the event data was collected.

SESSION_UUID

protected static final java.lang.String SESSION_UUID

See Also:

Constant Field Values

EVENT_CATEGORY

protected static final java.lang.String EVENT_CATEGORY

See Also:

Constant Field Values

EVENT_POSITION

protected static final java.lang.String EVENT_POSITION

See Also:

Constant Field Values

EVENT_NAME

protected static final java.lang.String EVENT_NAME

See Also:

Constant Field Values

Constructor Detail

EventData

protected EventData()

Method Detail

getSessionUuid

public java.lang.String getSessionUuid()

Returns:

Session UUID of JVM where this event data was collected.

getEventCategory

public java.lang.String getEventCategory()

Returns:

Identifier that categorizes events.

getEventName

public java.lang.String getEventName()

Returns:

Identifier of the event.

getEventPosition

public long getEventPosition()

Returns:

Time ordered position for multiple occurrences of the same event.

getFullID

public java.lang.String getFullID()

getTime

public long getTime()

Returns:

Timestamp when the event data was collected.

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 abstract 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.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

isSameAs

public final boolean isSameAs(EventData other)

Indicates whether this event represents the same as the given argument, based on session uuid, category, name and position.

Parameters:

other - the other event to compare to.

Returns:

true if this event represents the same event as argument, false otherwise.

isCompletelyEqualsTo

public final boolean isCompletelyEqualsTo(EventData other)

Indicates weather all properties are equal to the respective properties of the other instance given as argument. Used only in unit tests.

Parameters:

other - the other EventData instance been compared to.

Returns:

true if all properties are equal on the other instance, false otherwise.

isCompletelyEqualsImpl

protected abstract boolean isCompletelyEqualsImpl(EventData other)

Subclasses shall provide an implementation that compares its specific properties to the respective properties of the other instance given as argument. This method is called once and shall compare all specific properties.

Parameters:

other - the other EventData instance been compared to.

Returns:

true if all specific properties are equal on the other instance, false otherwise.

readableString

public abstract java.lang.StringBuilder readableString(java.lang.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.

write

public final java.lang.StringBuilder write(java.lang.StringBuilder sb,
                                           char messagePrefix)

Writes an encoded string representation of the event into the supplied StringBuilder.

Parameters:

sb - The StringBuilder that receives the encoded representation.

messagePrefix - A prefix character used by an parser to recognize the encoded message.

Returns:

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

writePropertiesImpl

protected abstract void writePropertiesImpl(EventWriter w)

Subclasses shall provide an implementation that appends its specific properties to the encoded string representation. This method is called once and shall append all specific properties using the EventWriter.

Parameters:

w - The EventWriter that encodes the properties.

read

protected final boolean read(java.lang.String message,
                             char messagePrefix)

Reads an event from the encoded string representation. If string is not well formed, returns false, but some properties may already have been assigned.

Parameters:

message - The string that is supposed to contain an encoded string representation of the event.

messagePrefix - message prefix

Returns:

true if an event was successfully read; false otherwise.

readPropertyImpl

protected abstract boolean readPropertyImpl(EventReader reader,
                                            java.lang.String key)
                                     throws java.io.IOException

Subclasses shall provide an implementation that reads its specific properties from the encoded string representation. This method is called for each encoded property.

Parameters:

reader - The EventReader that is parsing the message. Use this parser to retrieve the property value.

key - The property key.

Returns:

true if the property key was recognized, false otherwise.

Throws:

java.io.IOException - the EventReader failed to parse the encoded property value.