Package uk.co.real_logic.sbe.ir

Enum Class Signal

java.lang.Object

java.lang.Enum<Signal>

uk.co.real_logic.sbe.ir.Signal

All Implemented Interfaces:

Serializable, Comparable<Signal>, Constable

public enum Signal
extends Enum<Signal>

Signal the Token role within a stream of tokens. These signals begin/end various entities such as fields, composites, messages, repeating groups, enumerations, bitsets, etc.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BEGIN_COMPOSITE	Denotes the beginning of a composite.
BEGIN_ENUM	Denotes the beginning of an enumeration.
BEGIN_FIELD	Denotes the beginning of a field.
BEGIN_GROUP	Denotes the beginning of a repeating group.
BEGIN_MESSAGE	Denotes the beginning of a message.
BEGIN_SET	Denotes the beginning of a bitset.
BEGIN_VAR_DATA	Denotes the beginning of a variable data block.
CHOICE	Denotes a bit value (choice) of a bitset.
ENCODING	Denotes the Token is an encoding.
END_COMPOSITE	Denotes the end of a composite.
END_ENUM	Denotes the end of an enumeration.
END_FIELD	Denotes the end of a field.
END_GROUP	Denotes the end of a repeating group.
END_MESSAGE	Denotes the end of a message.
END_SET	Denotes the end of a bitset.
END_VAR_DATA	Denotes the end of a variable data block.
VALID_VALUE	Denotes a value of an enumeration.

Method Summary

Modifier and Type	Method	Description
static Signal	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Signal[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BEGIN_MESSAGE

public static final Signal BEGIN_MESSAGE

Denotes the beginning of a message.

END_MESSAGE

public static final Signal END_MESSAGE

Denotes the end of a message.

BEGIN_COMPOSITE

public static final Signal BEGIN_COMPOSITE

Denotes the beginning of a composite.

END_COMPOSITE

public static final Signal END_COMPOSITE

Denotes the end of a composite.

BEGIN_FIELD

public static final Signal BEGIN_FIELD

Denotes the beginning of a field.

END_FIELD

public static final Signal END_FIELD

Denotes the end of a field.

BEGIN_GROUP

public static final Signal BEGIN_GROUP

Denotes the beginning of a repeating group.

END_GROUP

public static final Signal END_GROUP

Denotes the end of a repeating group.

BEGIN_ENUM

public static final Signal BEGIN_ENUM

Denotes the beginning of an enumeration.

VALID_VALUE

public static final Signal VALID_VALUE

Denotes a value of an enumeration.

END_ENUM

public static final Signal END_ENUM

Denotes the end of an enumeration.

BEGIN_SET

public static final Signal BEGIN_SET

Denotes the beginning of a bitset.

CHOICE

public static final Signal CHOICE

Denotes a bit value (choice) of a bitset.

END_SET

public static final Signal END_SET

Denotes the end of a bitset.

BEGIN_VAR_DATA

public static final Signal BEGIN_VAR_DATA

Denotes the beginning of a variable data block.

END_VAR_DATA

public static final Signal END_VAR_DATA

Denotes the end of a variable data block.

ENCODING

public static final Signal ENCODING

Denotes the Token is an encoding.

Method Details

values

public static Signal[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Signal valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null