uk.co.real_logic.sbe.ir

Class Encoding

java.lang.Object

uk.co.real_logic.sbe.ir.Encoding

public class Encoding
extends java.lang.Object

Optional encoding settings that can be associated with Tokens.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Encoding.Builder Builder to make Encoding easier to create.
static class	Encoding.Presence Indicates the presence status of a primitive encoded field in a message.

Constructor Summary

Constructors

Constructor and Description
Encoding()
Encoding(Encoding.Presence presence, PrimitiveType primitiveType, java.nio.ByteOrder byteOrder, PrimitiveValue minValue, PrimitiveValue maxValue, PrimitiveValue nullValue, PrimitiveValue constValue, java.lang.String characterEncoding, java.lang.String epoch, java.lang.String timeUnit, java.lang.String semanticType)

Method Summary

Modifier and Type	Method and Description
PrimitiveValue	applicableMaxValue() The most applicable max value for the encoded type.
PrimitiveValue	applicableMinValue() The most applicable min value for the encoded type.
PrimitiveValue	applicableNullValue() The most applicable null value for the encoded type.
java.nio.ByteOrder	byteOrder() The ByteOrder for this encoding.
java.lang.String	characterEncoding() The character encoding for the token or null if not set.
PrimitiveValue	constValue() The constant value for the token or null if not set.
java.lang.String	epoch() The epoch from which a timestamp is offset.
PrimitiveValue	maxValue() The max value for the token or null if not set.
PrimitiveValue	minValue() The min value for the token or null if not set.
PrimitiveValue	nullValue() The null value for the token or null if not set.
Encoding.Presence	presence() Indicates the presence status of a field in a message.
void	presence(Encoding.Presence presence) Set the Encoding.Presence for this encoding.
PrimitiveType	primitiveType() The PrimitiveType of this encoding.
java.lang.String	semanticType() The semantic type of an encoding which can have relevance to the application layer.
java.lang.String	timeUnit() The time unit of the timestamp.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoding

public Encoding()

Encoding

public Encoding(Encoding.Presence presence,
                PrimitiveType primitiveType,
                java.nio.ByteOrder byteOrder,
                PrimitiveValue minValue,
                PrimitiveValue maxValue,
                PrimitiveValue nullValue,
                PrimitiveValue constValue,
                java.lang.String characterEncoding,
                java.lang.String epoch,
                java.lang.String timeUnit,
                java.lang.String semanticType)

Method Detail

primitiveType

public PrimitiveType primitiveType()

The PrimitiveType of this encoding.

Returns:

the PrimitiveType of this encoding.

byteOrder

public java.nio.ByteOrder byteOrder()

The ByteOrder for this encoding.

Returns:

the ByteOrder for this encoding.

minValue

public PrimitiveValue minValue()

The min value for the token or null if not set.

Returns:

the minValue for the token or null if not set.

maxValue

public PrimitiveValue maxValue()

The max value for the token or null if not set.

Returns:

the maxValue for the token or null if not set.

nullValue

public PrimitiveValue nullValue()

The null value for the token or null if not set.

Returns:

the nullValue for the token or null if not set.

constValue

public PrimitiveValue constValue()

The constant value for the token or null if not set.

Returns:

the constant value for the token or null if not set.

presence

public Encoding.Presence presence()

Indicates the presence status of a field in a message.

Returns:

indicates the presence status of a field in a message.

presence

public void presence(Encoding.Presence presence)

Set the Encoding.Presence for this encoding.

Parameters:

presence - the Encoding.Presence for this encoding.

applicableNullValue

public PrimitiveValue applicableNullValue()

The most applicable null value for the encoded type.

Returns:

most applicable null value for the encoded type.

applicableMinValue

public PrimitiveValue applicableMinValue()

The most applicable min value for the encoded type.

Returns:

most applicable min value for the encoded type.

applicableMaxValue

public PrimitiveValue applicableMaxValue()

The most applicable max value for the encoded type.

Returns:

most applicable max value for the encoded type.

characterEncoding

public java.lang.String characterEncoding()

The character encoding for the token or null if not set.

Returns:

the character encoding for the token or null if not set.

epoch

public java.lang.String epoch()

The epoch from which a timestamp is offset. The default is "unix".

Returns:

the epoch from which a timestamp is offset.

timeUnit

public java.lang.String timeUnit()

The time unit of the timestamp.

Returns:

the time unit of the timestamp.

semanticType

public java.lang.String semanticType()

The semantic type of an encoding which can have relevance to the application layer.

Returns:

semantic type of an encoding which can have relevance to the application layer.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object