com.codepoetics.protonpack.stateful

Interface StateMachine<S,I,O>

Type Parameters:

S - The type of the machine's states.

I - The type of the inputs.

O - The type of the outputs.

All Known Implementing Classes:

ComposedStateMachine, LastMatchingFinderStateMachine, SubsetCheckingStateMachine, TaggingStateMachine, TerminatingActionStateMachine, WindowingStateMachine

public interface StateMachine<S,I,O>

A state machine that receives items from an input stream and performs a state transition for each item, emitting zero or more outputs.

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.
static <S,I,O> StateMachine<S,I,O>	create(java.util.function.Supplier<S> initialState, java.util.function.BiFunction<S,I,Transition<S,O>> transitionFunction) Use the given transition function to create a state machine that never terminates, and releases no final outputs at the end of processing.
static <S,I,O> StateMachine<S,I,O>	create(java.util.function.Supplier<S> initialState, java.util.function.BiFunction<S,I,Transition<S,O>> transitionFunction, java.util.function.Predicate<S> isTerminal) Use the given transition function to create a state machine that terminates if the terminating condition is met, but releases no final outputs at the end of processing.
static <S,I,O> StateMachine<S,I,O>	create(java.util.function.Supplier<S> initialState, java.util.function.BiFunction<S,I,Transition<S,O>> transitionFunction, java.util.function.Predicate<S> isTerminal, java.util.function.Function<S,java.util.stream.Stream<O>> finisher) Use the given transition function to create a state machine that terminates if the terminating condition is met, and may release final outputs at the end of processing.
default 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()
default boolean	isTerminal(S state) Test whether a given state is terminal and stream traversal should stop.
default StateMachineRunner<S,I,O>	runner()
default StateMachineRunner<S,I,O>	runnerWith(S initialState)

Method Detail

create

static <S,I,O> StateMachine<S,I,O> create(java.util.function.Supplier<S> initialState,
                                          java.util.function.BiFunction<S,I,Transition<S,O>> transitionFunction)

Use the given transition function to create a state machine that never terminates, and releases no final outputs at the end of processing.

Type Parameters:

S - The type of the machine's states.

I - The type of the inputs.

O - The type of the outputs.

Parameters:

initialState - The initial state of the state machine.

transitionFunction - The transition function to use.

Returns:

The constructed state machine.

create

static <S,I,O> StateMachine<S,I,O> create(java.util.function.Supplier<S> initialState,
                                          java.util.function.BiFunction<S,I,Transition<S,O>> transitionFunction,
                                          java.util.function.Predicate<S> isTerminal)

Use the given transition function to create a state machine that terminates if the terminating condition is met, but releases no final outputs at the end of processing.

Type Parameters:

S - The type of the machine's states.

I - The type of the inputs.

O - The type of the outputs.

Parameters:

initialState - The initial state of the state machine.

transitionFunction - The transition function to use.

isTerminal - The condition that determines when a state is terminal.

Returns:

The constructed state machine.

create

static <S,I,O> StateMachine<S,I,O> create(java.util.function.Supplier<S> initialState,
                                          java.util.function.BiFunction<S,I,Transition<S,O>> transitionFunction,
                                          java.util.function.Predicate<S> isTerminal,
                                          java.util.function.Function<S,java.util.stream.Stream<O>> finisher)

Use the given transition function to create a state machine that terminates if the terminating condition is met, and may release final outputs at the end of processing.

Type Parameters:

S - The type of the machine's states.

I - The type of the inputs.

O - The type of the outputs.

Parameters:

initialState - The initial state of the state machine.

transitionFunction - The transition function to use.

isTerminal - The condition that determines when a state is terminal.

finisher - The function that releases final outputs at the end of processing.

Returns:

The constructed state machine.

apply

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.

Parameters:

state - The state to transition from.

input - The input to apply to the state.

Returns:

The transition.

isTerminal

default boolean isTerminal(S state)

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

Parameters:

state - The state to test.

Returns:

True if the state is terminal, false otherwise.

finish

default 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.

Parameters:

finalState - The state at the end of the stream.

Returns:

The final outputs from the state machine.

getInitialState

S getInitialState()

runner

default StateMachineRunner<S,I,O> runner()

runnerWith

default StateMachineRunner<S,I,O> runnerWith(S initialState)