io.hektor.fsm.builder.impl

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

java.lang.Object

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

All Implemented Interfaces:

TransitionBuilder<E,S,C,D>

public class TransitionBuilderImpl<E,S extends Enum<S>,C extends Context,D extends Data>
extends Object
implements TransitionBuilder<E,S,C,D>

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
TransitionBuilderImpl(S toState, Class<E> event)
TransitionBuilderImpl(S toState, Class<E> event, boolean isDefault)
TransitionBuilderImpl(S toState, Class<E> event, boolean isDefault, boolean isTransient)

Method Summary

Modifier and Type	Method and Description
Transition<E,S,C,D>	build()
TransitionBuilder<E,S,C,D>	consume() An empty action will be installed that will just silently consume the event.
TransitionBuilder<E,S,C,D>	withAction(Action<E,C,D> action)
TransitionBuilder<E,S,C,D>	withAction(Consumer<E> action)
TransitionBuilder<E,S,C,D>	withGuard(Guard<E,C,D> guard)
TransitionBuilder<E,S,C,D>	withGuard(Predicate<E> guard)
<R> TransitionBuilder<E,S,C,D>	withTransformation(Function<E,R> transformation) For transitions to a transient state, you can optionally specify a transformation that will be applied to the original event before entering the state you're automatically transitioning to.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitionBuilderImpl

public TransitionBuilderImpl(S toState,
                             Class<E> event)

TransitionBuilderImpl

public TransitionBuilderImpl(S toState,
                             Class<E> event,
                             boolean isDefault)

TransitionBuilderImpl

public TransitionBuilderImpl(S toState,
                             Class<E> event,
                             boolean isDefault,
                             boolean isTransient)

Method Detail

withGuard

public TransitionBuilder<E,S,C,D> withGuard(Predicate<E> guard)

Specified by:

withGuard in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>

Returns:

withGuard

public TransitionBuilder<E,S,C,D> withGuard(Guard<E,C,D> guard)

Specified by:

withGuard in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>

Returns:

consume

public TransitionBuilder<E,S,C,D> consume()

An empty action will be installed that will just silently consume the event.

Specified by:

consume in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>

withAction

public TransitionBuilder<E,S,C,D> withAction(Consumer<E> action)

Specified by:

withAction in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>

withAction

public TransitionBuilder<E,S,C,D> withAction(Action<E,C,D> action)

Specified by:

withAction in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>

withTransformation

public <R> TransitionBuilder<E,S,C,D> withTransformation(Function<E,R> transformation)
                                                  throws IllegalStateException

Description copied from interface: TransitionBuilder

For transitions to a transient state, you can optionally specify a transformation that will be applied to the original event before entering the state you're automatically transitioning to. NOTE: the validation that the target state is indeed a transient state cannot be performed until the actual state machine definition is built (FSMBuilder.build()) so if you specify a transformation on a Transition that go to a "regular" state, then it will not be detected until later at which time an FSMBuilderException will be thrown.

Specified by:

withTransformation in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>

Returns:

Throws:

IllegalStateException - in case a transformation has already been specified.

build

public Transition<E,S,C,D> build()

Specified by:

build in interface TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data>