Package uk.co.real_logic.sbe.xml

Class SetType

java.lang.Object

uk.co.real_logic.sbe.xml.Type

uk.co.real_logic.sbe.xml.SetType

public class SetType
extends Type

SBE set tpe representing a bitset of options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetType.Choice	Holder for valid values for SBE schema enum type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_TYPE	SBE schema set type.

Constructor Summary

Constructors

Constructor	Description
SetType(Node node, String givenName, String referencedName)	Construct a new SetType from XML Schema.

Method Summary

Modifier and Type	Method	Description
Collection<SetType.Choice>	choices()	The collection of possible SetType.Choice values for a bitset.
int	encodedLength()	The encodedLength (in octets) of the encodingType
PrimitiveType	encodingType()	The encoding type of the bitset to be used on the wire.
SetType.Choice	getChoice(String name)	Get the SetType.Choice represented by a String name.
SetType.Choice	getChoice(PrimitiveValue value)	Get the SetType.Choice represented by a PrimitiveValue.
boolean	isVariableLength()	Always false.
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 Details

SET_TYPE

public static final String SET_TYPE

SBE schema set type.

See Also:

• Constant Field Values

Constructor Details

SetType

public SetType(Node node,
 String givenName,
 String referencedName)
        throws XPathExpressionException

Construct a new SetType from XML Schema.

Parameters:

node - from the XML Schema Parsing

givenName - for the node.

referencedName - of the type when created from a ref in a composite.

Throws:

XPathExpressionException - on invalid XPath.

Method Details

encodingType

public PrimitiveType encodingType()

The encoding type of the bitset to be used on the wire.

Returns:

encoding type of the bitset to be used on the wire.

encodedLength

public int encodedLength()

The encodedLength (in octets) of the encodingType

Specified by:

encodedLength in class Type

Returns:

encodedLength of the encodingType

getChoice

public SetType.Choice getChoice(PrimitiveValue value)

Get the SetType.Choice represented by a PrimitiveValue.

Parameters:

value - to get

Returns:

the SetType.Choice represented by a PrimitiveValue or null if not found.

getChoice

public SetType.Choice getChoice(String name)

Get the SetType.Choice represented by a String name.

Parameters:

name - to get

Returns:

the SetType.Choice represented by a String name or null if not found.

choices

public Collection<SetType.Choice> choices()

The collection of possible SetType.Choice values for a bitset.

Returns:

the collection of possible SetType.Choice values for a bitset.

isVariableLength

public boolean isVariableLength()

Always false.

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