uk.co.real_logic.sbe.xml

Class CompositeType

java.lang.Object

uk.co.real_logic.sbe.xml.Type

uk.co.real_logic.sbe.xml.CompositeType

public class CompositeType
extends Type

SBE compositeType which is a composite of other composites, sets, enums, or simple types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPOSITE_TYPE SBE schema composite type.

Method Summary

Modifier and Type	Method and Description
void	checkForValidOffsets(Node node) Check the composite for any specified offsets and validate they are correctly specified.
void	checkForWellFormedGroupSizeEncoding(Node node) Check the composite for being a well-formed group encodedLength encoding.
void	checkForWellFormedMessageHeader(Node node) Check the composite for being a well-formed message headerStructure encoding.
void	checkForWellFormedVariableLengthDataEncoding(Node node) Check the composite for being a well-formed variable length data encoding.
int	encodedLength() The encodedLength (in octets) of the list of encoded types.
Type	getType(String name) Return the EncodedDataType within this composite with the given name.
List<Type>	getTypeList() Return list of the Types that compose this composite.
boolean	isVariableLength() Is the type variable length when encoded.
void	makeDataFieldCompositeType() Make this composite type, if it has a varData member, variable length by making the type with the name "varData" be variable length.
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

COMPOSITE_TYPE

public static final String COMPOSITE_TYPE

SBE schema composite type.

See Also:

Constant Field Values

Method Detail

getType

public Type getType(String name)

Return the EncodedDataType within this composite with the given name.

Parameters:

name - of the type to return.

Returns:

type requested.

encodedLength

public int encodedLength()

The encodedLength (in octets) of the list of encoded types.

Specified by:

encodedLength in class Type

Returns:

encodedLength of the compositeType.

getTypeList

public List<Type> getTypeList()

Return list of the Types that compose this composite.

Returns:

List that holds the Types in this composite.

makeDataFieldCompositeType

public void makeDataFieldCompositeType()

Make this composite type, if it has a varData member, variable length by making the type with the name "varData" be variable length.

checkForWellFormedGroupSizeEncoding

public void checkForWellFormedGroupSizeEncoding(Node node)

Check the composite for being a well-formed group encodedLength encoding. This means that there are the fields "blockLength" and "numInGroup" present.

Parameters:

node - of the XML for this composite.

checkForWellFormedVariableLengthDataEncoding

public void checkForWellFormedVariableLengthDataEncoding(Node node)

Check the composite for being a well-formed variable length data encoding. This means that there are the fields "length" and "varData" present.

Parameters:

node - of the XML for this composite

checkForWellFormedMessageHeader

public void checkForWellFormedMessageHeader(Node node)

Check the composite for being a well-formed message headerStructure encoding. This means that there are the fields "blockLength", "templateId" and "version" present.

Parameters:

node - of the XML for this composite

checkForValidOffsets

public void checkForValidOffsets(Node node)

Check the composite for any specified offsets and validate they are correctly specified.

Parameters:

node - of the XML for this composite

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