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 enumType

Nested Class Summary

Nested Classes

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

Field Summary

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

DEFAULT_PRESENCE

Constructor Summary

Constructors

Constructor and Description
EnumType(Node node) Construct a new enumType from XML Schema.

Method Summary

Modifier and Type	Method and Description
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.
PrimitiveValue	nullValue() The nullValue of the type
int	size() The size (in octets) of the encodingType
Collection<EnumType.ValidValue>	validValues() The collection of valid values for this enumeration.

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

description, name, presence, semanticType

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumType

public EnumType(Node node)
         throws XPathExpressionException

Construct a new enumType from XML Schema.

Parameters:

node - from the XML Schema Parsing

Throws:

XPathExpressionException - if the XPath is invalid

Method Detail

encodingType

public PrimitiveType encodingType()

The PrimitiveType used to encode the enum.

Returns:

the PrimitiveType used to encode the enum.

size

public int size()

The size (in octets) of the encodingType

Specified by:

size in class Type

Returns:

size 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.