org.tools4j.elara.plugin.timer

Enum TimerCommands

java.lang.Object

java.lang.Enum<TimerCommands>

org.tools4j.elara.plugin.timer.TimerCommands

All Implemented Interfaces:

Serializable, Comparable<TimerCommands>

public enum TimerCommands
extends Enum<TimerCommands>

Timer commands issued through TimerTriggerInput either when outputting an event through the command loopback or when polling the timer trigger input.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRIGGER_TIMER Command issued by TimerTriggerInput; its processing subsequently triggers a TimerEvents.TIMER_EXPIRED event.

Method Summary

Modifier and Type	Method and Description
static boolean	isTimerCommand(Command command)
static boolean	isTimerCommand(Frame frame)
static boolean	isTimerCommandType(int commandType)
static String	timerCommandName(Command command)
static String	timerCommandName(Frame frame)
static String	timerCommandName(int commandType)
static long	timerId(Command command)
static int	timerRepetition(Command command)
static long	timerTimeout(Command command)
static int	timerType(Command command)
static int	triggerTimer(MutableDirectBuffer buffer, int offset, long timerId, int timerType, int repetition, long timeout)
static TimerCommands	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimerCommands[]	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

TRIGGER_TIMER

public static final int TRIGGER_TIMER

Command issued by TimerTriggerInput; its processing subsequently triggers a TimerEvents.TIMER_EXPIRED event.

See Also:

Constant Field Values

Method Detail

values

public static TimerCommands[] 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 (TimerCommands c : TimerCommands.values())
    System.out.println(c);

Returns:

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

valueOf

public static TimerCommands 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

triggerTimer

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

timerId

public static long timerId(Command command)

timerType

public static int timerType(Command command)

timerRepetition

public static int timerRepetition(Command command)

timerTimeout

public static long timerTimeout(Command command)

isTimerCommand

public static boolean isTimerCommand(Command command)

isTimerCommand

public static boolean isTimerCommand(Frame frame)

isTimerCommandType

public static boolean isTimerCommandType(int commandType)

timerCommandName

public static String timerCommandName(Command command)

timerCommandName

public static String timerCommandName(Frame frame)

timerCommandName

public static String timerCommandName(int commandType)