io.hektor.fsm.impl

Class StateImpl<S extends Enum<S>,C extends Context,D extends Data>

java.lang.Object

io.hektor.fsm.impl.StateImpl<S,C,D>

All Implemented Interfaces:

State<S,C,D>

public class StateImpl<S extends Enum<S>,C extends Context,D extends Data>
extends Object
implements State<S,C,D>

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
StateImpl(S state, boolean isInitial, boolean isFinal, boolean isTransient, List<Transition<?,S,C,D>> transitions, Optional<Transition<?,S,C,D>> defaultTransition, BiConsumer<C,D> enterAction, BiConsumer<C,D> exitAction)

Method Summary

Modifier and Type	Method and Description
Optional<Transition<? extends Object,S,C,D>>	accept(Object event, C ctx, D data) See if this State would accept the given event.
List<S>	getConnectedNodes() Retrieve a list of all other states this state is connected to.
Optional<BiConsumer<C,D>>	getEnterAction()
Optional<BiConsumer<C,D>>	getExitAction()
S	getState() Retrieve the enum value of the state.
List<Transition<?,S,C,D>>	getTransitionsToState(S state)
boolean	isFinal() Check whether or not this state is final.
boolean	isInital() Check whether or not this state is initial.
boolean	isTransient() Check whether or not this state is a transient state.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateImpl

public StateImpl(S state,
                 boolean isInitial,
                 boolean isFinal,
                 boolean isTransient,
                 List<Transition<?,S,C,D>> transitions,
                 Optional<Transition<?,S,C,D>> defaultTransition,
                 BiConsumer<C,D> enterAction,
                 BiConsumer<C,D> exitAction)

Method Detail

getTransitionsToState

public List<Transition<?,S,C,D>> getTransitionsToState(S state)

getState

public S getState()

Description copied from interface: State

Retrieve the enum value of the state.

Specified by:

getState in interface State<S extends Enum<S>,C extends Context,D extends Data>

getEnterAction

public Optional<BiConsumer<C,D>> getEnterAction()

Specified by:

getEnterAction in interface State<S extends Enum<S>,C extends Context,D extends Data>

getExitAction

public Optional<BiConsumer<C,D>> getExitAction()

Specified by:

getExitAction in interface State<S extends Enum<S>,C extends Context,D extends Data>

isInital

public boolean isInital()

Description copied from interface: State

Check whether or not this state is initial.

Specified by:

isInital in interface State<S extends Enum<S>,C extends Context,D extends Data>

isFinal

public boolean isFinal()

Description copied from interface: State

Check whether or not this state is final.

Specified by:

isFinal in interface State<S extends Enum<S>,C extends Context,D extends Data>

isTransient

public boolean isTransient()

Description copied from interface: State

Check whether or not this state is a transient state.

Specified by:

isTransient in interface State<S extends Enum<S>,C extends Context,D extends Data>

getConnectedNodes

public List<S> getConnectedNodes()

Description copied from interface: State

Retrieve a list of all other states this state is connected to. This is just the "forward" connections. I.e., if A is connected to B, then A would return a list of one element with B in it. However, B doesn't really know that A is connected to it so if you'd ask B for all its connections, then A would not be part of that list (unless of course you actually specified that on the B state explicitly)

Specified by:

getConnectedNodes in interface State<S extends Enum<S>,C extends Context,D extends Data>

Returns:

a list of states this state is connected to.

accept

public Optional<Transition<? extends Object,S,C,D>> accept(Object event,
                                                           C ctx,
                                                           D data)

Description copied from interface: State

See if this State would accept the given event.

Specified by:

accept in interface State<S extends Enum<S>,C extends Context,D extends Data>

Parameters:

event - the event to see if it is accepted by this state or not.

Returns:

if the State accepts the event, then an the Transition that ultimatelely was the one accepting the event will be returned. If not, an empty Optional will be returned.