Package dev.getelements.elements.sdk

Interface Event

public interface Event

Represents an event to be handled by Element instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Event.Builder	Utility class to build Event instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SYSTEM_EVENT_PREFIX	All event names with the following prefix are considered system events.

Method Summary

Modifier and Type	Method	Description
static Event.Builder	builder()	Returns a new Event.Builder for Event instances.
List<Object>	getEventArguments()	Get the arguments of the Event.
String	getEventName()	The Event name.
default boolean	isSystemEvent()	True if the event is a system event.

Field Details

SYSTEM_EVENT_PREFIX

static final String SYSTEM_EVENT_PREFIX

All event names with the following prefix are considered system events. Applications should not use events prefixed with this string.

See Also:

• Constant Field Values

Method Details

isSystemEvent

default boolean isSystemEvent()

True if the event is a system event.

Returns:

true if system event, false otherwise.

getEventName

String getEventName()

The Event name. The names of events are application specific. However, they should follow a globally unique naming pattern. Additionally, SYSTEM_EVENT_PREFIX prefixed events are reserved for the SDK and should not be used.

Returns:

the name of hte event.

getEventArguments

List<Object> getEventArguments()

Get the arguments of the Event. When using argument-based matching, each argument must be non-null and must match based on exact class type. The dispatch mechanism does not honor polymorphism.

Returns:

the arguments

builder

static Event.Builder builder()

Returns a new Event.Builder for Event instances.

Returns:

the Event.Builder