SignalCodec (Simple Binary Encoding (SBE))

java.lang.Object
- java.lang.Enum<SignalCodec>
- - uk.co.real_logic.sbe.ir.generated.SignalCodec

All Implemented Interfaces:

Serializable, Comparable<SignalCodec>
```
public enum SignalCodec
extends Enum<SignalCodec>
```
Token signal type in IR.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BEGIN_COMPOSITE` Signal the beginning of a composite.
`BEGIN_ENUM` Signal the beginning of a enum.
`BEGIN_FIELD` Signal the beginning of a field.
`BEGIN_GROUP` Signal the beginning of a group.
`BEGIN_MESSAGE` Signal the beginning of a message.
`BEGIN_SET` Signal the beginning of a set.
`BEGIN_VAR_DATA` Signal the beginning of variable data.
`CHOICE` Signal the choice in a set.
`ENCODING` Signal the encoding of a field.
`END_COMPOSITE` Signal the end of a composite.
`END_ENUM` Signal the end of a enum.
`END_FIELD` Signal end beginning of a field.
`END_GROUP` Signal the end of a group.
`END_MESSAGE` Signal the end of a message.
`END_SET` Signal the end of a set.
`END_VAR_DATA` Signal the end of variable data.
`NULL_VAL` To be used to represent not present or null.
`VALID_VALUE` Signal a value of an enum.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SignalCodec`	`get(short value)` Lookup the enum value representing the value.
`short`	`value()` The raw encoded value in the Java type representation.
`static SignalCodec`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SignalCodec[]`	`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
  - BEGIN_MESSAGE
```
public static final SignalCodec BEGIN_MESSAGE
```
    Signal the beginning of a message.
  - END_MESSAGE
```
public static final SignalCodec END_MESSAGE
```
    Signal the end of a message.
  - BEGIN_COMPOSITE
```
public static final SignalCodec BEGIN_COMPOSITE
```
    Signal the beginning of a composite.
  - END_COMPOSITE
```
public static final SignalCodec END_COMPOSITE
```
    Signal the end of a composite.
  - BEGIN_FIELD
```
public static final SignalCodec BEGIN_FIELD
```
    Signal the beginning of a field.
  - END_FIELD
```
public static final SignalCodec END_FIELD
```
    Signal end beginning of a field.
  - BEGIN_GROUP
```
public static final SignalCodec BEGIN_GROUP
```
    Signal the beginning of a group.
  - END_GROUP
```
public static final SignalCodec END_GROUP
```
    Signal the end of a group.
  - BEGIN_ENUM
```
public static final SignalCodec BEGIN_ENUM
```
    Signal the beginning of a enum.
  - VALID_VALUE
```
public static final SignalCodec VALID_VALUE
```
    Signal a value of an enum.
  - END_ENUM
```
public static final SignalCodec END_ENUM
```
    Signal the end of a enum.
  - BEGIN_SET
```
public static final SignalCodec BEGIN_SET
```
    Signal the beginning of a set.
  - CHOICE
```
public static final SignalCodec CHOICE
```
    Signal the choice in a set.
  - END_SET
```
public static final SignalCodec END_SET
```
    Signal the end of a set.
  - BEGIN_VAR_DATA
```
public static final SignalCodec BEGIN_VAR_DATA
```
    Signal the beginning of variable data.
  - END_VAR_DATA
```
public static final SignalCodec END_VAR_DATA
```
    Signal the end of variable data.
  - ENCODING
```
public static final SignalCodec ENCODING
```
    Signal the encoding of a field.
  - NULL_VAL
```
public static final SignalCodec NULL_VAL
```
    To be used to represent not present or null.
- Method Detail
  - values
```
public static SignalCodec[] 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 (SignalCodec c : SignalCodec.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SignalCodec 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
  - value
```
public short value()
```
    The raw encoded value in the Java type representation.
    
    Returns:
    
    the raw value encoded.
  - get
```
public static SignalCodec get(short value)
```
    Lookup the enum value representing the value.
    
    Parameters:
    
    value - encoded to be looked up.
    
    Returns:
    
    the enum value representing the value.

Enum SignalCodec

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BEGIN_MESSAGE

END_MESSAGE

BEGIN_COMPOSITE

END_COMPOSITE

BEGIN_FIELD

END_FIELD

BEGIN_GROUP

END_GROUP

BEGIN_ENUM

VALID_VALUE

END_ENUM

BEGIN_SET

CHOICE

END_SET

BEGIN_VAR_DATA

END_VAR_DATA

ENCODING

NULL_VAL

Method Detail

values

valueOf

value

get