org.intellimate.izou.sdk.frameworks.presence.events

Class LeavingEvent

java.lang.Object

org.intellimate.izou.sdk.events.Event

org.intellimate.izou.sdk.frameworks.presence.events.LeavingEvent

All Implemented Interfaces:

EventModel<Event>, Identifiable

public class LeavingEvent
extends Event

this event guarantees that the user is not around anymore (as much as possible).

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERAL_DESCRIPTOR this event does not mean the user is able to notice anything (can be used for warm-up), it indicates he might be
static String	ID it means that the addon can guarantee that the user entered an area near izou
static String	STRICT_DESCRIPTOR it means that the addon can guarantee that the user left an area near izou

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LeavingEvent(Identification source, List<String> descriptors) Creates a new Event Object

Method Summary

Modifier and Type	Method and Description
static Optional<LeavingEvent>	createLeavingEvent(Identification source, boolean strict, List<String> descriptors) creates a new LeavingEvent

Methods inherited from class org.intellimate.izou.sdk.events.Event

addDescriptor, addEventLifeCycleListener, addResource, addResources, containsDescriptor, createEvent, createEvent, getAllInformations, getDescriptors, getEventBehaviourController, getID, getListResourceContainer, getSource, getType, lifecycleCallback, replaceDescriptors, setDescriptors, 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

Field Detail

GENERAL_DESCRIPTOR

public static final String GENERAL_DESCRIPTOR

this event does not mean the user is able to notice anything (can be used for warm-up), it indicates he might be

See Also:

Constant Field Values

STRICT_DESCRIPTOR

public static final String STRICT_DESCRIPTOR

it means that the addon can guarantee that the user left an area near izou

See Also:

Constant Field Values

ID

public static final String ID

it means that the addon can guarantee that the user entered an area near izou

See Also:

Constant Field Values

Constructor Detail

LeavingEvent

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

Creates a new Event Object

Parameters:

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

Method Detail

createLeavingEvent

public static Optional<LeavingEvent> createLeavingEvent(Identification source,
                                                        boolean strict,
                                                        List<String> descriptors)

creates a new LeavingEvent

Parameters:

source - the caller

strict - whether the addon can guarantee that the user is around

descriptors - the descriptors

Returns:

the optional PresenceEvent