com.fluxtion.api.event

Class Event

java.lang.Object

com.fluxtion.api.event.Event

Direct Known Subclasses:

GenericEvent

public abstract class Event
extends Object

Event class that feeds into a Simple Event Processor(SEP). Users should extend this class to define their own events. To dispatch the events Fluxtion uses either a statically defined ID, where the value of ID must be unique for the events in this SEP.

     public static final int ID = 1;
 

If no ID is defined then the SEP uses the class name to perform a dispatch, generally this will be less efficient at runtime but is easier for the developer at compile time. When class name is used, uniqueness is guaranteed by the fully qualified class name in this case. The efficiency of dispatch depends upon the target platform, so for some targets class name dispatch may be more efficient. An event can provide a filter field as either an int or a String, this allow eventhandlers to filter the type of events they receive. The eventhandler decides at compile time whether it will filter using Strings or integers.

Author:

Greg Higgins

Field Summary

Fields

Modifier and Type	Field and Description
protected int	filterId
protected String	filterString
static int	NO_ID default ID for an event when the user does not explicitly set an ID.

Constructor Summary

Constructors

Constructor and Description
Event()
Event(int id)
Event(int id, int filterId)
Event(int id, int filterId, String filterString)
Event(int id, String filterString)

Method Summary

Modifier and Type	Method and Description
int	eventId() The unique int identifier for this event.
CharSequence	filterCharSequence()
int	filterId() The integer id of a filter for this event, can be used interchangeably with filterString.
String	filterString() The String id of a filter for this event, can be used interchangeably with filterId.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ID

public static final int NO_ID

default ID for an event when the user does not explicitly set an ID. Any Event using this value for an ID will dispatch based on class name and not on ID. User defined events should not use the value Integer.MAX_VALUE

See Also:

Constant Field Values

filterId

protected int filterId

filterString

protected String filterString

Constructor Detail

Event

public Event()

Event

public Event(int id)

Event

public Event(int id,
             int filterId)

Event

public Event(int id,
             String filterString)

Event

public Event(int id,
             int filterId,
             String filterString)

Method Detail

eventId

public final int eventId()

The unique int identifier for this event.

Returns:

id for this event as an integer

filterId

public final int filterId()

The integer id of a filter for this event, can be used interchangeably with filterString. The event handler decides whether it will filter using Strings or integer's, calling this method if filtering is integer based. Integer filtering will generally be more efficient than string filtering, but this depends upon the underlying target platform processing characteristics.

Returns:

optional event filter id as integer

filterString

public final String filterString()

The String id of a filter for this event, can be used interchangeably with filterId. The event handler decides whether it will filter using Strings or integer's, calling this method if String filtering is string based. Integer filtering will generally be more efficient than string filtering, but this depends upon the underlying target platform processing characteristics.

Returns:

optional event filter id as String

filterCharSequence

public final CharSequence filterCharSequence()