com.codepoetics.protonpack.stateful

Class ComposedStateMachine<S,I,O>

java.lang.Object

com.codepoetics.protonpack.stateful.ComposedStateMachine<S,I,O>

All Implemented Interfaces:

StateMachine<S,I,O>

public class ComposedStateMachine<S,I,O>
extends Object
implements StateMachine<S,I,O>

Method Summary

Modifier and Type	Method and Description
Transition<S,O>	apply(S state, I input) Apply the given input to the given state, returning a transition to a new state with 0 or more outputs.
java.util.stream.Stream<O>	finish(S finalState) Based on the final state (if non-terminal), obtain any "left-over" outputs when the end of the stream is reached.
S	getInitialState()
boolean	isTerminal(S state) Test whether a given state is terminal and stream traversal should stop.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codepoetics.protonpack.stateful.StateMachine

create, create, create, runner, runnerWith

Method Detail

getInitialState

public S getInitialState()

Specified by:

getInitialState in interface StateMachine<S,I,O>

apply

public Transition<S,O> apply(S state,
                             I input)

Description copied from interface: StateMachine

Apply the given input to the given state, returning a transition to a new state with 0 or more outputs.

Specified by:

apply in interface StateMachine<S,I,O>

Parameters:

state - The state to transition from.

input - The input to apply to the state.

Returns:

The transition.

isTerminal

public boolean isTerminal(S state)

Description copied from interface: StateMachine

Test whether a given state is terminal and stream traversal should stop.

Specified by:

isTerminal in interface StateMachine<S,I,O>

Parameters:

state - The state to test.

Returns:

True if the state is terminal, false otherwise.

finish

public java.util.stream.Stream<O> finish(S finalState)

Description copied from interface: StateMachine

Based on the final state (if non-terminal), obtain any "left-over" outputs when the end of the stream is reached.

Specified by:

finish in interface StateMachine<S,I,O>

Parameters:

finalState - The state at the end of the stream.

Returns:

The final outputs from the state machine.