org.tools4j.elara.plugin.timer

Enum TimerEvents

java.lang.Object

java.lang.Enum<TimerEvents>

org.tools4j.elara.plugin.timer.TimerEvents

All Implemented Interfaces:

Serializable, Comparable<TimerEvents>

public enum TimerEvents
extends Enum<TimerEvents>

Timer events applying the timer state change through TimerEventApplier.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TIMER_EXPIRED Event type for event indicating a timer has fired and expired; it is single fire event of a one-off timer or the last fire event of a periodic timer.
static int	TIMER_FIRED Event type for event indicating a timer has fired; the timer has remaining repetitions and will fire again.
static int	TIMER_STARTED Event type for event indicating that a timer has been started.
static int	TIMER_STOPPED Event type for event indicating that a timer has been stopped.

Method Summary

Modifier and Type	Method and Description
static boolean	isTimerEvent(Event event)
static boolean	isTimerEvent(Frame frame)
static boolean	isTimerEventType(int eventType)
static int	periodicStarted(MutableDirectBuffer buffer, int offset, long timerId, int timerType, long timeout)
static void	routePeriodicStarted(long timerId, int timerType, long timeout, EventRouter eventRouter)
static void	routeTimerStarted(long timerId, int timerType, long timeout, EventRouter eventRouter)
static void	routeTimerStopped(long timerId, int timerType, int repetition, long timeout, EventRouter eventRouter)
static String	timerEventName(Event event)
static String	timerEventName(Frame frame)
static String	timerEventName(int eventType)
static int	timerExpired(MutableDirectBuffer buffer, int offset, Command command)
static int	timerFired(MutableDirectBuffer buffer, int offset, Command command)
static long	timerId(Event event)
static int	timerRepetition(Event event)
static int	timerStarted(MutableDirectBuffer buffer, int offset, long timerId, int timerType, long timeout)
static int	timerStopped(MutableDirectBuffer buffer, int offset, long timerId, int timerType, int repetition, long timeout)
static long	timerTimeout(Event event)
static int	timerType(Event event)
static TimerEvents	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimerEvents[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TIMER_FIRED

public static final int TIMER_FIRED

Event type for event indicating a timer has fired; the timer has remaining repetitions and will fire again. This event is usually triggered by a TRIGGER_TIMER command.

See Also:

Constant Field Values

TIMER_EXPIRED

public static final int TIMER_EXPIRED

Event type for event indicating a timer has fired and expired; it is single fire event of a one-off timer or the last fire event of a periodic timer. This event is usually triggered by a TRIGGER_TIMER command.

See Also:

Constant Field Values

TIMER_STARTED

public static final int TIMER_STARTED

Event type for event indicating that a timer has been started.

See Also:

Constant Field Values

TIMER_STOPPED

public static final int TIMER_STOPPED

Event type for event indicating that a timer has been stopped.

See Also:

Constant Field Values

Method Detail

values

public static TimerEvents[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimerEvents c : TimerEvents.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimerEvents valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

routeTimerStarted

public static void routeTimerStarted(long timerId,
                                     int timerType,
                                     long timeout,
                                     EventRouter eventRouter)

routePeriodicStarted

public static void routePeriodicStarted(long timerId,
                                        int timerType,
                                        long timeout,
                                        EventRouter eventRouter)

routeTimerStopped

public static void routeTimerStopped(long timerId,
                                     int timerType,
                                     int repetition,
                                     long timeout,
                                     EventRouter eventRouter)

timerStarted

public static int timerStarted(MutableDirectBuffer buffer,
                               int offset,
                               long timerId,
                               int timerType,
                               long timeout)

periodicStarted

public static int periodicStarted(MutableDirectBuffer buffer,
                                  int offset,
                                  long timerId,
                                  int timerType,
                                  long timeout)

timerStopped

public static int timerStopped(MutableDirectBuffer buffer,
                               int offset,
                               long timerId,
                               int timerType,
                               int repetition,
                               long timeout)

timerFired

public static int timerFired(MutableDirectBuffer buffer,
                             int offset,
                             Command command)

timerExpired

public static int timerExpired(MutableDirectBuffer buffer,
                               int offset,
                               Command command)

timerId

public static long timerId(Event event)

timerType

public static int timerType(Event event)

timerRepetition

public static int timerRepetition(Event event)

timerTimeout

public static long timerTimeout(Event event)

isTimerEvent

public static boolean isTimerEvent(Event event)

isTimerEvent

public static boolean isTimerEvent(Frame frame)

isTimerEventType

public static boolean isTimerEventType(int eventType)

timerEventName

public static String timerEventName(Event event)

timerEventName

public static String timerEventName(Frame frame)

timerEventName

public static String timerEventName(int eventType)