Package uk.co.real_logic.sbe.generation.common

Class FieldPrecedenceModel.CodecInteraction.CodecInteractionFactory

java.lang.Object

uk.co.real_logic.sbe.generation.common.FieldPrecedenceModel.CodecInteraction.CodecInteractionFactory

Enclosing class:

FieldPrecedenceModel.CodecInteraction

public static final class FieldPrecedenceModel.CodecInteraction.CodecInteractionFactory
extends Object

Factory for creating FieldPrecedenceModel.CodecInteraction instances. This factory is used to hash-cons the instances, so that they can be compared by reference.

Method Summary

Modifier and Type	Method	Description
FieldPrecedenceModel.CodecInteraction	accessField(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent accessing the field identified by the given token.
FieldPrecedenceModel.CodecInteraction	accessVarDataLength(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent accessing the length of a variable-length data field without advancing the codec position.
FieldPrecedenceModel.CodecInteraction	determineGroupHasElements(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent determining a repeating group has elements.
FieldPrecedenceModel.CodecInteraction	determineGroupIsEmpty(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent determining a repeating group is empty.
FieldPrecedenceModel.CodecInteraction	moveToLastElement(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent moving to the last element in a repeating group.
FieldPrecedenceModel.CodecInteraction	moveToNextElement(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent moving to the next element in a repeating group.
FieldPrecedenceModel.CodecInteraction	resetCountToIndex(Token token)	Find or create a FieldPrecedenceModel.CodecInteraction to represent resetting the count of a repeating group to the current index.
FieldPrecedenceModel.CodecInteraction	wrap(int version)	Find or create a FieldPrecedenceModel.CodecInteraction to represent wrapping a codec around the given version of data.

Methods inherited from class java.lang.Object

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

Method Details

wrap

public FieldPrecedenceModel.CodecInteraction wrap(int version)

Find or create a FieldPrecedenceModel.CodecInteraction to represent wrapping a codec around the given version of data.

Parameters:

version - the version of data to wrap

Returns:

the FieldPrecedenceModel.CodecInteraction instance

accessField

public FieldPrecedenceModel.CodecInteraction accessField(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent accessing the field identified by the given token.

The supplied token must carry a Signal.BEGIN_FIELD or Signal.BEGIN_VAR_DATA signal.

Parameters:

token - the token identifying the field

Returns:

the FieldPrecedenceModel.CodecInteraction instance

determineGroupIsEmpty

public FieldPrecedenceModel.CodecInteraction determineGroupIsEmpty(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent determining a repeating group is empty.

For encoding, this will be when the group count is supplied, e.g., encoder.myGroupCount(0).

For decoding, this will be when the group is read, e.g., decoder.myGroup().

The supplied token must carry a Signal.BEGIN_GROUP signal.

Parameters:

token - the token identifying the group

Returns:

the FieldPrecedenceModel.CodecInteraction instance

determineGroupHasElements

public FieldPrecedenceModel.CodecInteraction determineGroupHasElements(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent determining a repeating group has elements.

For encoding, this will be when the group count is supplied, e.g., encoder.myGroupCount(1).

For decoding, this will be when the group is read, e.g., decoder.myGroup().

The supplied token must carry a Signal.BEGIN_GROUP signal.

Parameters:

token - the token identifying the group

Returns:

the FieldPrecedenceModel.CodecInteraction instance

moveToNextElement

public FieldPrecedenceModel.CodecInteraction moveToNextElement(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent moving to the next element in a repeating group.

For encoders, decoders, and codecs, this will be when the next element is accessed, e.g., myGroup.next() when myGroup.count - myGroup.index > 1.

The supplied token must carry a Signal.BEGIN_GROUP signal.

Parameters:

token - the token identifying the group

Returns:

the FieldPrecedenceModel.CodecInteraction instance

moveToLastElement

public FieldPrecedenceModel.CodecInteraction moveToLastElement(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent moving to the last element in a repeating group.

For encoders, decoders, and codecs, this will be when the last element is accessed, e.g., myGroup.next() when myGroup.count - myGroup.index == 1.

Parameters:

token - the token identifying the group

Returns:

the FieldPrecedenceModel.CodecInteraction instance

resetCountToIndex

public FieldPrecedenceModel.CodecInteraction resetCountToIndex(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent resetting the count of a repeating group to the current index.

For encoders, decoders, and codecs, this will be when the resetCountToIndex method is called, e.g., myGroup.resetCountToIndex().

The supplied token must carry a Signal.BEGIN_GROUP signal.

Parameters:

token - the token identifying the group

Returns:

the FieldPrecedenceModel.CodecInteraction instance

accessVarDataLength

public FieldPrecedenceModel.CodecInteraction accessVarDataLength(Token token)

Find or create a FieldPrecedenceModel.CodecInteraction to represent accessing the length of a variable-length data field without advancing the codec position.

For decoders and codecs, this will be when the length is accessed, e.g., decoder.myVarDataLength().

The supplied token must carry a Signal.BEGIN_VAR_DATA signal.

Parameters:

token - the token identifying the field

Returns:

the FieldPrecedenceModel.CodecInteraction instance