Package 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
SBE enum type for representing an enumeration of values.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionintThe encodedLength (in octets) of the encodingTypeThePrimitiveTypeused to encode the enum.getValidValue(String name) Get theEnumType.ValidValuerepresented by a string name.getValidValue(PrimitiveValue value) Get theEnumType.ValidValuerepresented by aPrimitiveValue.booleanIs the type variable length when encoded.The nullValue of the type.toString()The collection of valid values for this enumeration.Methods inherited from class uk.co.real_logic.sbe.xml.Type
deprecated, description, name, offsetAttribute, offsetAttribute, packageName, presence, referencedName, semanticType, sinceVersion, sinceVersion
-
Field Details
-
ENUM_TYPE
SBE schema enum type.- See Also:
-
-
Method Details
-
encodingType
ThePrimitiveTypeused to encode the enum.- Returns:
- the
PrimitiveTypeused to encode the enum.
-
encodedLength
public int encodedLength()The encodedLength (in octets) of the encodingType- Specified by:
encodedLengthin classType- Returns:
- encodedLength of the encodingType
-
getValidValue
Get theEnumType.ValidValuerepresented by aPrimitiveValue.- Parameters:
value- to lookup- Returns:
- the
EnumType.ValidValuerepresented by aPrimitiveValueor null.
-
getValidValue
Get theEnumType.ValidValuerepresented by a string name.- Parameters:
name- to lookup- Returns:
- the
EnumType.ValidValuerepresented by a string name or null.
-
nullValue
The nullValue of the type.- Returns:
- value of the nullValue.
-
validValues
The collection of valid values for this enumeration.- Returns:
- the collection of valid values for this enumeration.
-
isVariableLength
public boolean isVariableLength()Is the type variable length when encoded.- Specified by:
isVariableLengthin classType- Returns:
- true if the type is variable length when encoded.
-
toString
-