Package uk.co.real_logic.sbe.otf

Class AbstractTokenListener

java.lang.Object
uk.co.real_logic.sbe.otf.AbstractTokenListener
All Implemented Interfaces:
TokenListener
public abstract class AbstractTokenListener extends Object implements TokenListener
Abstract TokenListener that can be extended when not all callback methods are required.

By extending this class there is a possibility for the optimizer to elide unused methods otherwise requiring polymorphic dispatch.

  • Constructor Details

    • AbstractTokenListener

      public AbstractTokenListener()

  • Method Details

    • onBeginMessage

      public void onBeginMessage(Token token)
      Called on beginning the decoding of a message.
      Specified by:
      onBeginMessage in interface TokenListener
      Parameters:
      token - representing the IR for message including metadata.

    • onEndMessage

      public void onEndMessage(Token token)
      Called on end of decoding of a message.
      Specified by:
      onEndMessage in interface TokenListener
      Parameters:
      token - representing the IR for message including metadata.

    • onEncoding

      public void onEncoding(Token fieldToken, DirectBuffer buffer, int bufferIndex, Token typeToken, int actingVersion)
      Primitive encoded type encountered. This can be a root block field or field within a composite or group.

      Within a composite the typeToken and fieldToken are the same.

      Specified by:
      onEncoding in interface TokenListener
      Parameters:
      fieldToken - in the IR representing the field of the message root or group.
      buffer - containing the encoded message.
      bufferIndex - at which the encoded field begins.
      typeToken - of the encoded primitive value.
      actingVersion - of the encoded message for determining validity of extension fields.

    • onEnum

      public void onEnum(Token fieldToken, DirectBuffer buffer, int bufferIndex, List<Token> tokens, int fromIndex, int toIndex, int actingVersion)
      Enum encoded type encountered.
      Specified by:
      onEnum in interface TokenListener
      Parameters:
      fieldToken - in the IR representing the field of the message root or group.
      buffer - containing the encoded message.
      bufferIndex - at which the encoded field begins.
      tokens - describing the message.
      fromIndex - at which the enum metadata begins.
      toIndex - at which the enum metadata ends.
      actingVersion - of the encoded message for determining validity of extension fields.

    • onBitSet

      public void onBitSet(Token fieldToken, DirectBuffer buffer, int bufferIndex, List<Token> tokens, int fromIndex, int toIndex, int actingVersion)
      BitSet encoded type encountered.
      Specified by:
      onBitSet in interface TokenListener
      Parameters:
      fieldToken - in the IR representing the field of the message root or group.
      buffer - containing the encoded message.
      bufferIndex - at which the encoded field begins.
      tokens - describing the message.
      fromIndex - at which the bit set metadata begins.
      toIndex - at which the bit set metadata ends.
      actingVersion - of the encoded message for determining validity of extension fields.

    • onBeginComposite

      public void onBeginComposite(Token fieldToken, List<Token> tokens, int fromIndex, int toIndex)
      Beginning of Composite encoded type encountered.
      Specified by:
      onBeginComposite in interface TokenListener
      Parameters:
      fieldToken - in the IR representing the field of the message root or group.
      tokens - describing the message.
      fromIndex - at which the composite metadata begins.
      toIndex - at which the composite metadata ends.

    • onEndComposite

      public void onEndComposite(Token fieldToken, List<Token> tokens, int fromIndex, int toIndex)
      End of Composite encoded type encountered.
      Specified by:
      onEndComposite in interface TokenListener
      Parameters:
      fieldToken - in the IR representing the field of the message root or group.
      tokens - describing the message.
      fromIndex - at which the composite metadata begins.
      toIndex - at which the composite metadata ends.

    • onGroupHeader

      public void onGroupHeader(Token token, int numInGroup)
      Group encountered.
      Specified by:
      onGroupHeader in interface TokenListener
      Parameters:
      token - describing the group.
      numInGroup - number of times the group will be repeated.

    • onBeginGroup

      public void onBeginGroup(Token token, int groupIndex, int numInGroup)
      Beginning of group encoded type encountered.
      Specified by:
      onBeginGroup in interface TokenListener
      Parameters:
      token - describing the group.
      groupIndex - index for the repeat count of the group.
      numInGroup - number of times the group will be repeated.

    • onEndGroup

      public void onEndGroup(Token token, int groupIndex, int numInGroup)
      End of group encoded type encountered.
      Specified by:
      onEndGroup in interface TokenListener
      Parameters:
      token - describing the group.
      groupIndex - index for the repeat count of the group.
      numInGroup - number of times the group will be repeated.

    • onVarData

      public void onVarData(Token fieldToken, DirectBuffer buffer, int bufferIndex, int length, Token typeToken)
      Var data field encountered.
      Specified by:
      onVarData in interface TokenListener
      Parameters:
      fieldToken - in the IR representing the var data field.
      buffer - containing the encoded message.
      bufferIndex - at which the variable data begins.
      length - of the variable data in bytes.
      typeToken - of the variable data. Needed to determine character encoding of the variable data.