org.openksavi.sponge.core.event

Class BaseEvent

java.lang.Object

org.openksavi.sponge.core.event.BaseEvent

All Implemented Interfaces:

Serializable, Cloneable, Event, HasPriority<Event>

Direct Known Subclasses:

AttributeMapEvent, BaseControlEvent

public abstract class BaseEvent
extends Object
implements Event

Base event.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected EventClonePolicy	clonePolicy Event clone policy.
static int	DEFAULT_PRIORITY Default event priority.
protected String	id Event ID.
protected String	name Event name.
protected Instant	time Event creation time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEvent(String name, EventClonePolicy clonePolicy) Creates a new event that has no ID and time set (both are 0).

Method Summary

Modifier and Type	Method and Description
BaseEvent	clone()
protected abstract <T> T	doGet(String name, boolean useDefault, T defaultValue)
boolean	equalsByAttributes(Event event) Compares events by attributes.
boolean	equalsById(Event event) Compares events by ID.
<T> T	get(String name) Returns the attribute value or throws IllegalArgumentException if it does't exist.
<T> T	get(String name, Class<T> cls) Returns attribute value.
protected <T> T	getDefaultAttributeValue(String name, boolean useDefault, T defaultValue)
String	getId() Returns event ID.
String	getName() Returns event name.
<T> T	getOrDefault(String name, T defaultValue)
int	getPriority() Returns event priority.
Instant	getTime() Returns event time.
void	setId(String id) Sets event ID.
void	setTime(Instant time) Sets event time.
String	toString()
protected String	toStringBase()
protected void	valudateAttribute(String name, Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.event.Event

getAll, has, set

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

Default event priority. Equals to 0.

See Also:

Constant Field Values

id

protected String id

Event ID.

time

protected Instant time

Event creation time.

name

protected String name

Event name.

clonePolicy

protected EventClonePolicy clonePolicy

Event clone policy.

Constructor Detail

BaseEvent

protected BaseEvent(String name,
                    EventClonePolicy clonePolicy)

Creates a new event that has no ID and time set (both are 0).

Parameters:

name - an event name.

clonePolicy - an event clone policy.

Method Detail

getName

public String getName()

Returns event name.

Specified by:

getName in interface Event

Returns:

event name.

getTime

public Instant getTime()

Returns event time.

Specified by:

getTime in interface Event

Returns:

event time.

setTime

public void setTime(Instant time)

Sets event time.

Specified by:

setTime in interface Event

Parameters:

time - event time.

getId

public String getId()

Returns event ID.

Specified by:

getId in interface Event

Returns:

event ID.

setId

public void setId(String id)

Sets event ID.

Specified by:

setId in interface Event

Parameters:

id - event ID.

getPriority

public int getPriority()

Returns event priority. This is always 0 for standard events and cannot be changed.

Specified by:

getPriority in interface HasPriority<Event>

Returns:

event priority.

doGet

protected abstract <T> T doGet(String name,
                               boolean useDefault,
                               T defaultValue)

getDefaultAttributeValue

protected final <T> T getDefaultAttributeValue(String name,
                                               boolean useDefault,
                                               T defaultValue)

get

public final <T> T get(String name)

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

Specified by:

get in interface Event

Type Parameters:

T - attribute.

Parameters:

name - attribute name.

Returns:

attribute value.

get

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

Returns attribute value.

Specified by:

get in interface Event

Parameters:

name - attribute name.

cls - attribute class.

Returns:

attribute value.

getOrDefault

public final <T> T getOrDefault(String name,
                                T defaultValue)

Specified by:

getOrDefault in interface Event

equalsById

public boolean equalsById(Event event)

Compares events by ID.

Specified by:

equalsById in interface Event

Parameters:

event - compared event.

Returns:

true if both events are equal by ID.

equalsByAttributes

public boolean equalsByAttributes(Event event)

Compares events by attributes.

Specified by:

equalsByAttributes in interface Event

Parameters:

event - compared event.

Returns:

true if both events are equal by attributes.

valudateAttribute

protected void valudateAttribute(String name,
                                 Object value)

clone

public BaseEvent clone()

Specified by:

clone in interface Event

Overrides:

clone in class Object

toStringBase

protected final String toStringBase()

toString

public String toString()

Overrides:

toString in class Object