Package uk.co.real_logic.sbe.ir

Class Encoding

java.lang.Object
uk.co.real_logic.sbe.ir.Encoding
public class Encoding extends Object
Optional encoding settings that can be associated with Tokens.

  • Method Details

    • primitiveType

      public PrimitiveType primitiveType()
      The PrimitiveType of this encoding.
      Returns:
      the PrimitiveType of this encoding.

    • byteOrder

      public 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 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 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 String timeUnit()
      The time unit of the timestamp.
      Returns:
      the time unit of the timestamp.

    • semanticType

      public String semanticType()
      The semantic type of encoding value which can have relevance to the application layer.
      Returns:
      semantic type of encoding value which can have relevance to the application layer.

    • toString

      public String toString()
      Overrides:
      toString in class Object