org.openksavi.sponge.event

Interface Event

All Superinterfaces:

Cloneable, HasPriority<Event>, Serializable

All Known Subinterfaces:

ControlEvent

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

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

Method Summary

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

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

getPriority

Method Detail

getName

String getName()

Returns event name.

Returns:

event name.

getTime

Instant getTime()

Returns event time.

Returns:

event time.

setTime

void setTime(Instant time)

Sets event time.

Parameters:

time - event time.

getId

String getId()

Returns event ID.

Returns:

event ID.

setId

void setId(String id)

Sets event ID.

Parameters:

id - event ID.

get

Object get(String name)

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

Parameters:

name - attribute name.

Returns:

attribute value.

get

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

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

Type Parameters:

T - attribute.

Parameters:

name - attribute name.

cls - attribute class.

Returns:

attribute value.

set

Event set(String name,
          Object value)

Sets attribute value.

Parameters:

name - attribute name.

value - attribute value.

Returns:

this event for fluent API.

has

boolean has(String name)

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

Parameters:

name - attribute name.

Returns:

true if there is such attribute.

getAll

Map<String,Object> getAll()

Returns attribute map.

Returns:

attribute map.

equalsById

boolean equalsById(Event event)

Compares events by ID.

Parameters:

event - compared event.

Returns:

true if both events are equal by ID.

equalsByAttributes

boolean equalsByAttributes(Event event)

Compares events by attributes.

Parameters:

event - compared event.

Returns:

true if both events are equal by attributes.

clone

Event clone()

Clones this event. Attributes are deeply cloned.

Returns:

cloned event.