uk.co.real_logic.sbe.generation.common

Class FieldPrecedenceModel

java.lang.Object

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

public final class FieldPrecedenceModel
extends Object

A state machine that models whether codec interactions are safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldPrecedenceModel.CodecInteraction Represents an interaction against a codec, e.g., encoder.wrap(...) or decoder.myVarData().
static class	FieldPrecedenceModel.State A state in which a codec may reside.
static class	FieldPrecedenceModel.TransitionGroup A group of transitions that share the same end state.

Method Summary

Modifier and Type	Method and Description
void	forEachStateOrderedByStateNumber(Consumer<FieldPrecedenceModel.State> consumer) Iterates over the codec states in the order of their state numbers.
void	forEachTerminalEncoderState(Consumer<FieldPrecedenceModel.State> consumer) Iterates over the states in which a codec is fully encoded.
void	forEachTransition(FieldPrecedenceModel.CodecInteraction interaction, Consumer<FieldPrecedenceModel.TransitionGroup> consumer) Iterates over the possible state machine transitions due to the supplied codec interaction.
void	forEachTransitionFrom(FieldPrecedenceModel.State state, Consumer<FieldPrecedenceModel.TransitionGroup> consumer) Finds the possible transitions from a given state.
void	forEachWrappedStateByVersionDesc(IntObjConsumer<FieldPrecedenceModel.State> consumer) Iterates over the states after a codec is wrapped over a particular version of data.
String	generatedRepresentationClassName() Returns the name of the class that models the state machine in generated code.
void	generateGraph(StringBuilder sb, String indent) Encodes the state machine as a graphviz dot diagram.
FieldPrecedenceModel.CodecInteraction.CodecInteractionFactory	interactionFactory() Returns a hash-consing factory for codec interactions.
FieldPrecedenceModel.State	latestVersionWrappedState() The state after a codec is wrapped in the latest version.
static FieldPrecedenceModel	newInstance(String stateClassName, Token msgToken, List<Token> fields, List<Token> groups, List<Token> varData, Function<IntStream,IntStream> versionsSelector) Builds a state machine that models whether codec interactions are safe.
FieldPrecedenceModel.State	notWrappedState() The initial state before a codec is wrapped.
int	stateCount() Returns the number of states in the state machine.
int	versionCount() Returns the number of schema versions.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static FieldPrecedenceModel newInstance(String stateClassName,
                                               Token msgToken,
                                               List<Token> fields,
                                               List<Token> groups,
                                               List<Token> varData,
                                               Function<IntStream,IntStream> versionsSelector)

Builds a state machine that models whether codec interactions are safe.

Parameters:

stateClassName - the qualified name of the class that models the state machine in generated code

msgToken - the message token

fields - the fields in the message

groups - the groups in the message

varData - the varData in the message

versionsSelector - a function that selects the versions to model in the state machine

Returns:

the access order model

notWrappedState

public FieldPrecedenceModel.State notWrappedState()

The initial state before a codec is wrapped.

Returns:

the initial state before a codec is wrapped.

latestVersionWrappedState

public FieldPrecedenceModel.State latestVersionWrappedState()

The state after a codec is wrapped in the latest version.

Returns:

the state after a codec is wrapped in the latest version.

forEachWrappedStateByVersionDesc

public void forEachWrappedStateByVersionDesc(IntObjConsumer<FieldPrecedenceModel.State> consumer)

Iterates over the states after a codec is wrapped over a particular version of data.

Parameters:

consumer - the consumer of the states.

versionCount

public int versionCount()

Returns the number of schema versions.

Returns:

the number of schema versions.

forEachTerminalEncoderState

public void forEachTerminalEncoderState(Consumer<FieldPrecedenceModel.State> consumer)

Iterates over the states in which a codec is fully encoded.

Parameters:

consumer - the consumer of the states.

forEachStateOrderedByStateNumber

public void forEachStateOrderedByStateNumber(Consumer<FieldPrecedenceModel.State> consumer)

Iterates over the codec states in the order of their state numbers.

Parameters:

consumer - the consumer of the states.

stateCount

public int stateCount()

Returns the number of states in the state machine.

Returns:

the number of states in the state machine.

interactionFactory

public FieldPrecedenceModel.CodecInteraction.CodecInteractionFactory interactionFactory()

Returns a hash-consing factory for codec interactions. These interactions are the transitions in the state machine.

Returns:

a hash-consing factory for codec interactions.

See Also:

FieldPrecedenceModel.CodecInteraction

generatedRepresentationClassName

public String generatedRepresentationClassName()

Returns the name of the class that models the state machine in generated code.

Returns:

the name of the class that models the state machine in generated code.

forEachTransition

public void forEachTransition(FieldPrecedenceModel.CodecInteraction interaction,
                              Consumer<FieldPrecedenceModel.TransitionGroup> consumer)

Iterates over the possible state machine transitions due to the supplied codec interaction.

Parameters:

interaction - a codec interaction.

consumer - the consumer of the transitions.

forEachTransitionFrom

public void forEachTransitionFrom(FieldPrecedenceModel.State state,
                                  Consumer<FieldPrecedenceModel.TransitionGroup> consumer)

Finds the possible transitions from a given state.

Parameters:

state - the state to find transitions from.

consumer - the consumer of the transitions.

generateGraph

public void generateGraph(StringBuilder sb,
                          String indent)

Encodes the state machine as a graphviz dot diagram.

Parameters:

sb - the string builder to append to.

indent - the indentation to use.