io.hektor.fsm.impl

Class TransitionImpl<E,S extends Enum<S>,C extends Context,D extends Data>

java.lang.Object

io.hektor.fsm.impl.TransitionImpl<E,S,C,D>

All Implemented Interfaces:

Transition<E,S,C,D>

public class TransitionImpl<E,S extends Enum<S>,C extends Context,D extends Data>
extends Object
implements Transition<E,S,C,D>

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
TransitionImpl(String description, S to, Class<E> event, Predicate<E> guard, Guard<E,C,D> richerGuard, Consumer<E> action, Action<E,C,D> statefulAction, Function<E,?> transformation)

Method Summary

Modifier and Type	Method and Description
Optional<Consumer<E>>	getAction() Get the associated action wih this transition, if it exists.
Optional<Action<E,C,D>>	getStatefulAction()
S	getToState() This Transition represents the transition to this particular state.
Optional<Function<E,?>>	getTransformation() Get the transformation associated with this Transition.
boolean	match(Object event, C ctx, D data) See if the given event is matching this transition.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitionImpl

public TransitionImpl(String description,
                      S to,
                      Class<E> event,
                      Predicate<E> guard,
                      Guard<E,C,D> richerGuard,
                      Consumer<E> action,
                      Action<E,C,D> statefulAction,
                      Function<E,?> transformation)

Method Detail

match

public boolean match(Object event,
                     C ctx,
                     D data)

Description copied from interface: Transition

See if the given event is matching this transition.

Specified by:

match in interface Transition<E,S extends Enum<S>,C extends Context,D extends Data>

Parameters:

event - the event to match agianst this transition.

Returns:

true if the event indeed matches, false otherwise.

getToState

public S getToState()

Description copied from interface: Transition

This Transition represents the transition to this particular state. Assuming the event matches of course.

Specified by:

getToState in interface Transition<E,S extends Enum<S>,C extends Context,D extends Data>

Returns:

the to state

getAction

public Optional<Consumer<E>> getAction()

Description copied from interface: Transition

Get the associated action wih this transition, if it exists.

Specified by:

getAction in interface Transition<E,S extends Enum<S>,C extends Context,D extends Data>

getStatefulAction

public Optional<Action<E,C,D>> getStatefulAction()

Specified by:

getStatefulAction in interface Transition<E,S extends Enum<S>,C extends Context,D extends Data>

getTransformation

public Optional<Function<E,?>> getTransformation()

Description copied from interface: Transition

Get the transformation associated with this Transition. A transformation may only exists if this is a transition out of a transient state.

Specified by:

getTransformation in interface Transition<E,S extends Enum<S>,C extends Context,D extends Data>

Returns:

the optional transformation for a Transition out of a transient state.