uk.co.real_logic.sbe.xml

Class Type

java.lang.Object

uk.co.real_logic.sbe.xml.Type

Direct Known Subclasses:

CompositeType, EncodedDataType, EnumType, SetType

public abstract class Type
extends Object

An SBE type. One of encodedDataType, compositeType, enumType, or setType per the SBE spec.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PRESENCE Default presence attribute for Types

Constructor Summary

Constructors

Constructor and Description
Type(Node node) Construct a new Type from XML Schema.
Type(String name, Presence presence, String description, String semanticType) Construct a new Type from direct values.

Method Summary

Modifier and Type	Method and Description
String	description() The description of the Type (if set) or null
String	name() Return the name of the type
Presence	presence() Return the presence of the type
String	semanticType() The semanticType of the Type
abstract int	size() The size (in octets) of the Type.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRESENCE

public static final String DEFAULT_PRESENCE

Default presence attribute for Types

See Also:

Constant Field Values

Constructor Detail

Type

public Type(Node node)

Construct a new Type from XML Schema. Called by subclasses to mostly set common fields

Parameters:

node - from the XML Schema Parsing

Type

public Type(String name,
            Presence presence,
            String description,
            String semanticType)

Construct a new Type from direct values.

Parameters:

name - of the type

presence - of the type

description - of the type or null

semanticType - of the type or null

Method Detail

name

public String name()

Return the name of the type

Returns:

name of the Type

presence

public Presence presence()

Return the presence of the type

Returns:

presence of the Type

size

public abstract int size()

The size (in octets) of the Type. Overridden by subtypes. This returns 0 by default.

Returns:

size of the type in octets

description

public String description()

The description of the Type (if set) or null

Returns:

description set by the type or null

semanticType

public String semanticType()

The semanticType of the Type

Returns:

semanticType of the Type if set or null if not set