org.openksavi.sponge.event

Interface Event

All Superinterfaces:

Cloneable, Descriptive, HasFeatures, HasPriority<Event>, Serializable

All Known Subinterfaces:

ControlEvent

public interface Event
extends Cloneable, Serializable, HasPriority<Event>, Descriptive, HasFeatures

An event. Event has the following standard attributes: name (type), id, time, priority, label and description.

Method Summary

Modifier and Type	Method and Description
void	addFeature(String name, Object value) Adds a new event feature.
void	addFeatures(Map<String,Object> features) Adds event features.
Event	clone() Clones this event.
boolean	equalsByAttributes(Event event) Compares events by attributes.
boolean	equalsById(Event event) Compares events by ID.
<T> T	get(Class<T> cls, String name) Returns the attribute value or throws IllegalArgumentException if it does't exist.
<T> T	get(String name) Returns the attribute value or throws IllegalArgumentException if it does't exist.
<T> T	get(String name, T defaultValue) Returns the attribute value or defaultValue if it does't exist.
Map<String,Object>	getAll() Returns the attribute map.
String	getId() Returns the event ID.
String	getName() Returns the event name.
Instant	getTime() Returns the event time.
boolean	has(String name) Checks whether this event has an attribute with the specified name.
Event	set(Map<String,Object> attributes) Sets attributes.
Event	set(String name, Object value) Sets attribute value.
void	setId(String id) Sets the event ID.
void	setTime(Instant time) Sets the event time.

Methods inherited from interface org.openksavi.sponge.util.HasPriority

getPriority

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasFeatures

getFeatures, setFeatures

Method Detail

getName

String getName()

Returns the event name.

Specified by:

getName in interface Descriptive

Returns:

the event name.

getTime

Instant getTime()

Returns the event time.

Returns:

the event time.

setTime

void setTime(Instant time)

Sets the event time.

Parameters:

time - the event time.

getId

String getId()

Returns the event ID.

Returns:

the event ID.

setId

void setId(String id)

Sets the event ID.

Parameters:

id - the event ID.

get

<T> T get(String name)

Returns the attribute value or throws IllegalArgumentException if it does't exist.

Type Parameters:

T - attribute.

Parameters:

name - the attribute name.

Returns:

the attribute value.

get

<T> T get(Class<T> cls,
          String name)

Returns the attribute value or throws IllegalArgumentException if it does't exist.

Type Parameters:

T - attribute.

Parameters:

cls - the attribute class.

name - the attribute name.

Returns:

the attribute value.

get

<T> T get(String name,
          T defaultValue)

Returns the attribute value or defaultValue if it does't exist.

Type Parameters:

T - attribute.

Parameters:

name - the attribute name.

defaultValue - the default value.

Returns:

the attribute value.

set

Event set(String name,
          Object value)

Sets attribute value.

Parameters:

name - the attribute name.

value - the attribute value.

Returns:

this event for fluent API.

set

Event set(Map<String,Object> attributes)

Sets attributes.

Parameters:

attributes - the attributes as the map.

Returns:

this event for fluent API.

has

boolean has(String name)

Checks whether this event has an attribute with the specified name.

Parameters:

name - the attribute name.

Returns:

true if there is such attribute.

getAll

Map<String,Object> getAll()

Returns the attribute map.

Returns:

the attribute map.

addFeature

void addFeature(String name,
                Object value)

Adds a new event feature.

Parameters:

name - the feature name.

value - the feature value.

addFeatures

void addFeatures(Map<String,Object> features)

Adds event features.

Parameters:

features - the features.

equalsById

boolean equalsById(Event event)

Compares events by ID.

Parameters:

event - the compared event.

Returns:

true if both events are equal by ID.

equalsByAttributes

boolean equalsByAttributes(Event event)

Compares events by attributes.

Parameters:

event - the compared event.

Returns:

true if both events are equal by attributes.

clone

Event clone()

Clones this event.

Returns:

a cloned event.