uk.co.real_logic.sbe.xml

Class EncodedDataType

java.lang.Object

uk.co.real_logic.sbe.xml.Type

uk.co.real_logic.sbe.xml.EncodedDataType

public class EncodedDataType
extends Type

SBE encodedDataType

Field Summary

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

DEFAULT_PRESENCE

Constructor Summary

Constructors

Constructor and Description
EncodedDataType(Node node) Construct a new encodedDataType from XML Schema.
EncodedDataType(String name, Presence presence, String description, String semanticType, PrimitiveType primitiveType, int length, boolean varLen) Construct a new EncodedDataType with direct values.

Method Summary

Modifier and Type	Method and Description
String	characterEncoding() The character encoding of the type
PrimitiveValue	constVal() The constant value of the type if specified
boolean	isVariableLength() Return the variableLength attribute of the type
int	length() Return the length attribute of the type
PrimitiveValue	maxValue() The maxValue of the type
PrimitiveValue	minValue() The minValue of the type
PrimitiveValue	nullValue() The nullValue of the type
int	offsetAttribute() Return the offset attribute of the EncodedDataType from the schema
PrimitiveType	primitiveType() Return the primitiveType attribute of the type
int	sinceVersion() Return the sinceVersion of the EncodedDataType
int	size() The size (in octets) of the encoding as length of the primitiveType times its count.
void	variableLength(boolean variableLength)

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

EncodedDataType

public EncodedDataType(Node node)

Construct a new encodedDataType from XML Schema.

Parameters:

node - from the XML Schema Parsing

EncodedDataType

public EncodedDataType(String name,
                       Presence presence,
                       String description,
                       String semanticType,
                       PrimitiveType primitiveType,
                       int length,
                       boolean varLen)

Construct a new EncodedDataType with direct values. Does not handle constant values.

Parameters:

name - of the type

presence - of the type

description - of the type or null

semanticType - of the type or null

primitiveType - of the EncodedDataType

length - of the EncodedDataType

varLen - of the EncodedDataType

Method Detail

length

public int length()

Return the length attribute of the type

Returns:

length attribute of the type

isVariableLength

public boolean isVariableLength()

Return the variableLength attribute of the type

Returns:

variableLength boolean of the type

variableLength

public void variableLength(boolean variableLength)

primitiveType

public PrimitiveType primitiveType()

Return the primitiveType attribute of the type

Returns:

primitiveType attribute of the type

size

public int size()

The size (in octets) of the encoding as length of the primitiveType times its count.

Specified by:

size in class Type

Returns:

size of the encoding

constVal

public PrimitiveValue constVal()
                        throws IllegalArgumentException

The constant value of the type if specified

Returns:

value of the constant for this type

Throws:

IllegalArgumentException

minValue

public PrimitiveValue minValue()

The minValue of the type

Returns:

value of the minValue

maxValue

public PrimitiveValue maxValue()

The maxValue of the type

Returns:

value of the maxValue

nullValue

public PrimitiveValue nullValue()

The nullValue of the type

Returns:

value of the nullValue primitiveType or type

characterEncoding

public String characterEncoding()

The character encoding of the type

Returns:

value representing the encoding

sinceVersion

public int sinceVersion()

Return the sinceVersion of the EncodedDataType

Returns:

the sinceVersion value of the EncodedDataType

offsetAttribute

public int offsetAttribute()

Return the offset attribute of the EncodedDataType from the schema

Returns:

the offset attribute value or -1 to indicate not set by the schema