BaseEvent (Sponge - Core 1.16.1 API)

java.lang.Object
- org.openksavi.sponge.core.event.BaseEvent

All Implemented Interfaces:

Serializable, Cloneable, Event, Descriptive, HasFeatures, 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`	`description` Event description.
`protected String`	`id` Event ID.
`protected String`	`label` Event label.
`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).

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

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFeature(String name, Object value)`
`void`	`addFeatures(Map<String,Object> features)`
`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(Class<T> cls, String name)`
`<T> T`	`get(String name)` Returns the attribute value or throws `IllegalArgumentException` if it does't exist.
`<T> T`	`get(String name, T defaultValue)`
`protected <T> T`	`getDefaultAttributeValue(String name, boolean useDefault, T defaultValue)`
`String`	`getDescription()`
`Map<String,Object>`	`getFeatures()`
`String`	`getId()` Returns event ID.
`String`	`getLabel()`
`String`	`getName()` Returns event name.
`int`	`getPriority()` Returns event priority.
`Instant`	`getTime()` Returns event time.
`Event`	`set(Map<String,Object> attributes)`
`void`	`setDescription(String description)`
`void`	`setFeatures(Map<String,Object> features)`
`void`	`setId(String id)` Sets event ID.
`void`	`setLabel(String label)`
`void`	`setName(String name)`
`void`	`setTime(Instant time)` Sets event time.
`String`	`toString()`
`protected String`	`toStringBase()`
`protected void`	`validateAttribute(String name, Object value)`
`protected void`	`validateFeature(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.
  - label
```
protected String label
```
    Event label.
  - description
```
protected String description
```
    Event description.
- 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
    
    Specified by:
    
    getName in interface Descriptive
    
    Returns:
    
    event name.
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface Descriptive
  - 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.
  - getLabel
```
public String getLabel()
```
    Specified by:
    
    getLabel in interface Descriptive
  - setLabel
```
public void setLabel(String label)
```
    Specified by:
    
    setLabel in interface Descriptive
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface Descriptive
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface Descriptive
  - 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(Class<T> cls,
                       String name)
```
    Specified by:
    
    get in interface Event
  - get
```
public final <T> T get(String name,
                       T defaultValue)
```
    Specified by:
    
    get in interface Event
  - set
```
public Event set(Map<String,Object> attributes)
```
    Specified by:
    
    set 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.
  - validateAttribute
```
protected void validateAttribute(String name,
                                 Object value)
```
  - getFeatures
```
public Map<String,Object> getFeatures()
```
    Specified by:
    
    getFeatures in interface HasFeatures
  - setFeatures
```
public void setFeatures(Map<String,Object> features)
```
    Specified by:
    
    setFeatures in interface HasFeatures
  - addFeature
```
public void addFeature(String name,
                       Object value)
```
    Specified by:
    
    addFeature in interface Event
  - addFeatures
```
public void addFeatures(Map<String,Object> features)
```
    Specified by:
    
    addFeatures in interface Event
  - validateFeature
```
protected void validateFeature(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

Class BaseEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITY

id

time

name

clonePolicy

label

description

Constructor Detail

BaseEvent

Method Detail

getName

setName

getTime

setTime

getId

setId

getPriority

getLabel

setLabel

getDescription

setDescription

doGet

getDefaultAttributeValue

get

get

get

set

equalsById

equalsByAttributes

validateAttribute

getFeatures

setFeatures

addFeature

addFeatures

validateFeature

clone

toStringBase

toString