org.jlab.coda.emu.support.data

Enum ControlType

java.lang.Object

java.lang.Enum<ControlType>

org.jlab.coda.emu.support.data.ControlType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ControlType>

public enum ControlType
extends java.lang.Enum<ControlType>

This enum specifies tag values associated with CODA control types used in CODA online components.

Author:

timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
END
GO
PAUSE
PRESTART
SYNC

Method Summary

Modifier and Type	Method and Description
static ControlType	getControlType(int val) Obtain the enum from the value.
static ControlType	getControlTypeFromOrdinal(int val) Obtain the enum from the ordinal value.
static java.lang.String	getName(int val) Obtain the name from the value.
int	getOrdinalValue() Get the ordinal value of this enum.
int	getValue() Get the integer value of this enum.
static boolean	isControl(int value) Is this a control tag of any sort?
boolean	isEnd() Is this an "end" control tag?
static boolean	isEnd(int value) Is this an "end" control tag?
boolean	isGo() Is this a "go" control tag?
static boolean	isGo(int value) Is this a "go" control tag?
boolean	isPause() Is this a "pause" control tag?
static boolean	isPause(int value) Is this a "pause" control tag?
boolean	isPrestart() Is this a "prestart" control tag?
static boolean	isPrestart(int value) Is this a "prestart" control tag?
boolean	isSync() Is this a sync control tag?
static boolean	isSync(int value) Is this an "sync" control tag?
static ControlType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ControlType[]	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

Enum Constant Detail

SYNC

public static final ControlType SYNC

PRESTART

public static final ControlType PRESTART

GO

public static final ControlType GO

PAUSE

public static final ControlType PAUSE

END

public static final ControlType END

Method Detail

values

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

Returns:

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

valueOf

public static ControlType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getControlType

public static ControlType getControlType(int val)

Obtain the enum from the value.

Parameters:

val - the value to match.

Returns:

the matching enum, or null.

getControlTypeFromOrdinal

public static ControlType getControlTypeFromOrdinal(int val)

Obtain the enum from the ordinal value.

Parameters:

val - the ordinal value to match.

Returns:

the matching enum, or null.

getName

public static java.lang.String getName(int val)

Obtain the name from the value.

Parameters:

val - the value to match.

Returns:

the name, or null.

getValue

public int getValue()

Get the integer value of this enum.

Returns:

the integer value of this enum.

getOrdinalValue

public int getOrdinalValue()

Get the ordinal value of this enum.

Returns:

the ordinal value of this enum.

isControl

public static boolean isControl(int value)

Is this a control tag of any sort?

Parameters:

value - the tag value to check

Returns:

true if control tag or any sort, else false

isPrestart

public boolean isPrestart()

Is this a "prestart" control tag?

Returns:

true if prestart control tag, else false

isPrestart

public static boolean isPrestart(int value)

Is this a "prestart" control tag?

Parameters:

value - the tag value to check

Returns:

true if prestart control tag, else false

isGo

public boolean isGo()

Is this a "go" control tag?

Returns:

true if go control tag, else false

isGo

public static boolean isGo(int value)

Is this a "go" control tag?

Parameters:

value - the tag value to check

Returns:

true if go control tag, else false

isPause

public boolean isPause()

Is this a "pause" control tag?

Returns:

true if pause control tag, else false

isPause

public static boolean isPause(int value)

Is this a "pause" control tag?

Parameters:

value - the tag value to check

Returns:

true if pause control tag, else false

isEnd

public boolean isEnd()

Is this an "end" control tag?

Returns:

true if end control tag, else false

isEnd

public static boolean isEnd(int value)

Is this an "end" control tag?

Parameters:

value - the tag value to check

Returns:

true if end control tag, else false

isSync

public boolean isSync()

Is this a sync control tag?

Returns:

true if sync control tag, else false

isSync

public static boolean isSync(int value)

Is this an "sync" control tag?

Parameters:

value - the tag value to check

Returns:

true if end control tag, else false