uk.co.real_logic.sbe.xml

Class EnumType

java.lang.Object

uk.co.real_logic.sbe.xml.Type

uk.co.real_logic.sbe.xml.EnumType

public class EnumType
extends Type

SBE enum type for representing an enumeration of values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumType.ValidValue Holder for valid values for and EnumType.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENUM_TYPE SBE schema enum type.

Method Summary

Modifier and Type	Method and Description
int	encodedLength() The encodedLength (in octets) of the encodingType
PrimitiveType	encodingType() The PrimitiveType used to encode the enum.
EnumType.ValidValue	getValidValue(PrimitiveValue value) Get the EnumType.ValidValue represented by a PrimitiveValue.
EnumType.ValidValue	getValidValue(String name) Get the EnumType.ValidValue represented by a string name.
boolean	isVariableLength() Is the type variable length when encoded.
PrimitiveValue	nullValue() The nullValue of the type.
String	toString()
Collection<EnumType.ValidValue>	validValues() The collection of valid values for this enumeration.

Methods inherited from class uk.co.real_logic.sbe.xml.Type

deprecated, description, name, offsetAttribute, offsetAttribute, presence, referencedName, semanticType, sinceVersion, sinceVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ENUM_TYPE

public static final String ENUM_TYPE

SBE schema enum type.

See Also:

Constant Field Values

Method Detail

encodingType

public PrimitiveType encodingType()

The PrimitiveType used to encode the enum.

Returns:

the PrimitiveType used to encode the enum.

encodedLength

public int encodedLength()

The encodedLength (in octets) of the encodingType

Specified by:

encodedLength in class Type

Returns:

encodedLength of the encodingType

getValidValue

public EnumType.ValidValue getValidValue(PrimitiveValue value)

Get the EnumType.ValidValue represented by a PrimitiveValue.

Parameters:

value - to lookup

Returns:

the EnumType.ValidValue represented by a PrimitiveValue or null.

getValidValue

public EnumType.ValidValue getValidValue(String name)

Get the EnumType.ValidValue represented by a string name.

Parameters:

name - to lookup

Returns:

the EnumType.ValidValue represented by a string name or null.

nullValue

public PrimitiveValue nullValue()

The nullValue of the type.

Returns:

value of the nullValue.

validValues

public Collection<EnumType.ValidValue> validValues()

The collection of valid values for this enumeration.

Returns:

the collection of valid values for this enumeration.

isVariableLength

public boolean isVariableLength()

Is the type variable length when encoded.

Specified by:

isVariableLength in class Type

Returns:

true if the type is variable length when encoded.

toString

public String toString()

Overrides:

toString in class Object