org.intellimate.izou.sdk.events

Class Event

java.lang.Object

org.intellimate.izou.sdk.events.Event

All Implemented Interfaces:

EventModel<Event>, Identifiable

Direct Known Subclasses:

EndedEvent, LeavingEvent, MuteEvent, PlayerCommand, PlayerError, PlayerUpdate, PresenceEvent, StartEvent, StartMusicRequest, StopEvent, StopMusic, UnMuteEvent

public class Event
extends Object
implements EventModel<Event>

This class represents an Event. This class is immutable! for every change it will return an new instance!

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Event(String type, Identification source, List<String> descriptors) Creates a new Event Object
protected	Event(String type, Identification source, ListResourceProvider listResourceContainer, List<String> descriptors, EventBehaviourController eventBehaviourController) Creates a new Event Object

Method Summary

Modifier and Type	Method and Description
Event	addDescriptor(String descriptor) sets the Descriptors (but not the Event-Type).
Event	addEventLifeCycleListener(EventLifeCycle eventLifeCycle, java.util.function.Consumer<EventLifeCycle> cycleCallback) adds the Consumer to the specified EventLifeCycle.
Event	addResource(ResourceModel resource) adds a Resource to the Container
Event	addResources(List<ResourceModel> resources) adds a List of Resources to the Container
boolean	containsDescriptor(String descriptor) returns whether the event contains the specific descriptor.
static Optional<Event>	createEvent(String type, Identification source) Creates a new Event Object
static Optional<Event>	createEvent(String type, Identification source, List<String> descriptors) Creates a new Event Object
List<String>	getAllInformations() returns a List containing all the Descriptors and the type.
List<String>	getDescriptors() returns a List containing all the Descriptors.
EventBehaviourControllerModel	getEventBehaviourController() returns the associated EventBehaviourController
String	getID() The ID of the Event.
ListResourceProvider	getListResourceContainer() returns all the Resources the Event currently has
Identification	getSource() returns the Source of the Event, e.g.
String	getType() The type of the Event.
void	lifecycleCallback(EventLifeCycle eventLifeCycle)
Event	replaceDescriptors(List<String> descriptors) replaces the Descriptors
Event	setDescriptors(List<String> descriptors) sets the Descriptors (but not the Event-Type).
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

Event

protected Event(String type,
                Identification source,
                List<String> descriptors)
         throws IllegalArgumentException

Creates a new Event Object

Parameters:

type - the Type of the Event, try to use the predefined Event types

source - the source of the Event, most likely a this reference.

descriptors - the descriptors to initialize the Event with

Throws:

IllegalArgumentException - if one of the Arguments is null or empty

Event

protected Event(String type,
                Identification source,
                ListResourceProvider listResourceContainer,
                List<String> descriptors,
                EventBehaviourController eventBehaviourController)
         throws IllegalArgumentException

Creates a new Event Object

Parameters:

type - the Type of the Event, try to use the predefined Event types

source - the source of the Event, most likely a this reference.

listResourceContainer - the ResourceContainer

descriptors - the descriptors to initialize the Event with

eventBehaviourController - the Controller of the Event

Throws:

IllegalArgumentException - if one of the Arguments is null or empty

Method Detail

createEvent

public static Optional<Event> createEvent(String type,
                                          Identification source)

Creates a new Event Object

Parameters:

type - the Type of the Event, try to use the predefined Event types

source - the source of the Event, most likely a this reference.

Returns:

an Optional, that may be empty if type is null or empty or source is null

createEvent

public static Optional<Event> createEvent(String type,
                                          Identification source,
                                          List<String> descriptors)

Creates a new Event Object

Parameters:

type - the Type of the Event, try to use the predefined Event types

source - the source of the Event, most likely a this reference.

descriptors - the descriptors

Returns:

an Optional, that may be empty if type is null or empty or source is null

getID

public String getID()

The ID of the Event. It describes the Type of the Event.

Specified by:

getID in interface Identifiable

Returns:

A String containing an ID

getType

public String getType()

The type of the Event. It describes the Type of the Event.

Specified by:

getType in interface EventModel<Event>

Returns:

A String containing an ID

getSource

public Identification getSource()

returns the Source of the Event, e.g. the object who fired it.

Specified by:

getSource in interface EventModel<Event>

Returns:

an identifiable

getListResourceContainer

public ListResourceProvider getListResourceContainer()

returns all the Resources the Event currently has

Specified by:

getListResourceContainer in interface EventModel<Event>

Returns:

an instance of ListResourceContainer

addResource

public Event addResource(ResourceModel resource)

adds a Resource to the Container

Specified by:

addResource in interface EventModel<Event>

Parameters:

resource - an instance of the resource to add

Returns:

the resulting Event (which is the same instance)

addResources

public Event addResources(List<ResourceModel> resources)

adds a List of Resources to the Container

Specified by:

addResources in interface EventModel<Event>

Parameters:

resources - a list containing all the resources

getDescriptors

public List<String> getDescriptors()

returns a List containing all the Descriptors.

Specified by:

getDescriptors in interface EventModel<Event>

Returns:

a List containing the Descriptors

getAllInformations

public List<String> getAllInformations()

returns a List containing all the Descriptors and the type.

Specified by:

getAllInformations in interface EventModel<Event>

Returns:

a List containing the Descriptors

setDescriptors

public Event setDescriptors(List<String> descriptors)

sets the Descriptors (but not the Event-Type).

Replaces all existing descriptors. Since Event is immutable, it will create a new Instance.

Parameters:

descriptors - a List containing all the Descriptors

Returns:

the resulting Event (which is the same instance)

addDescriptor

public Event addDescriptor(String descriptor)

sets the Descriptors (but not the Event-Type).

Parameters:

descriptor - a String describing the Event.

Returns:

the resulting Event (which is the same instance)

replaceDescriptors

public Event replaceDescriptors(List<String> descriptors)

replaces the Descriptors

Parameters:

descriptors - a list containing the Descriptors.

Returns:

the resulting Event (which is the same instance)

containsDescriptor

public boolean containsDescriptor(String descriptor)

returns whether the event contains the specific descriptor. this method also checks whether it matches the type.

Specified by:

containsDescriptor in interface EventModel<Event>

Parameters:

descriptor - a String with the ID of the Descriptor

Returns:

boolean when the Event contains the descriptor, false when not.

getEventBehaviourController

public EventBehaviourControllerModel getEventBehaviourController()

returns the associated EventBehaviourController

Specified by:

getEventBehaviourController in interface EventModel<Event>

Returns:

an instance of EventBehaviourController

lifecycleCallback

public void lifecycleCallback(EventLifeCycle eventLifeCycle)

Specified by:

lifecycleCallback in interface EventModel<Event>

addEventLifeCycleListener

public Event addEventLifeCycleListener(EventLifeCycle eventLifeCycle,
                                       java.util.function.Consumer<EventLifeCycle> cycleCallback)

adds the Consumer to the specified EventLifeCycle. In its current implementation the invocation of the Callback method is parallel, but the notificaton of the listners not.

Parameters:

eventLifeCycle - the EventLifeCycle to target

cycleCallback - the callback

toString

public String toString()

Overrides:

toString in class Object