A B C D E F G I M N O P R S T V W

A

accept(E, C, D) - Method in interface io.hektor.fsm.Action

Performs this operation on the given arguments.

accept(Object, C, D) - Method in class io.hektor.fsm.impl.StateImpl

accept(Object, C, D) - Method in interface io.hektor.fsm.State

See if this State would accept the given event.

Action<E,C extends Context,D extends Data> - Interface in io.hektor.fsm

Represents an action to be performed in the context of a FSM.

ActionAlreadyDefinedException - Exception in io.hektor.fsm.builder.exceptions

Indicates that an action was already associated with the object (State or Transition)

ActionAlreadyDefinedException() - Constructor for exception io.hektor.fsm.builder.exceptions.ActionAlreadyDefinedException

ActionAlreadyDefinedException(String) - Constructor for exception io.hektor.fsm.builder.exceptions.ActionAlreadyDefinedException

asDefaultTransition() - Method in interface io.hektor.fsm.builder.EventBuildStep

B

build() - Method in class io.hektor.fsm.builder.FSMBuilder

Build the definition of the state machine and validate that all is well.

build() - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

build() - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

build() - Method in interface io.hektor.fsm.builder.StateBuilder

build() - Method in interface io.hektor.fsm.builder.TransitionBuilder

C

cancel() - Method in interface io.hektor.fsm.Cancellable

Cancellable - Interface in io.hektor.fsm

checkIfEmpty(String) - Static method in class io.hektor.fsm.PreConditions

Check if a string is empty, which includes null check.

checkIfNotEmpty(String) - Static method in class io.hektor.fsm.PreConditions

consume() - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

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

consume() - Method in interface io.hektor.fsm.builder.TransitionBuilder

Context - Interface in io.hektor.fsm

ContextTypeBuildStep<S extends Enum<S>> - Interface in io.hektor.fsm.builder

D

Data - Interface in io.hektor.fsm

DataTypeBuildStep<S extends Enum<S>,C extends Context> - Interface in io.hektor.fsm.builder

DefaultTransitionAlreadySpecifiedException - Exception in io.hektor.fsm.builder.exceptions

You can only have a single default transition for a transient state.

DefaultTransitionAlreadySpecifiedException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.DefaultTransitionAlreadySpecifiedException

Definition<S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm

DefinitionImpl<S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.impl

DefinitionImpl(State<S, C, D>[]) - Constructor for class io.hektor.fsm.impl.DefinitionImpl

E

ensureArgument(boolean, String) - Static method in class io.hektor.fsm.PreConditions

ensureNotEmpty(String, String) - Static method in class io.hektor.fsm.PreConditions

ensureNotNull(T, String) - Static method in class io.hektor.fsm.PreConditions

ensureNotNull(T) - Static method in class io.hektor.fsm.PreConditions

EventBuildStep<S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm.builder

F

FinalStateAlreadyDefinedException - Exception in io.hektor.fsm.builder.exceptions

Indicates that you tried to define a final state twice.

FinalStateAlreadyDefinedException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.FinalStateAlreadyDefinedException

FinalStateIsTransientException - Exception in io.hektor.fsm.builder.exceptions

Indicates that you tried to define the final state as transient, which you cannot do.

FinalStateIsTransientException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.FinalStateIsTransientException

FinalStateTransitionsException - Exception in io.hektor.fsm.builder.exceptions

Indicates that you tried to define transitions on a final state.

FinalStateTransitionsException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.FinalStateTransitionsException

FSM<S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm

FSMBuilder<S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.builder

FSMBuilder(S[]) - Constructor for class io.hektor.fsm.builder.FSMBuilder

FSMBuilderException - Exception in io.hektor.fsm.builder.exceptions

FSMBuilderException() - Constructor for exception io.hektor.fsm.builder.exceptions.FSMBuilderException

FSMBuilderException(String) - Constructor for exception io.hektor.fsm.builder.exceptions.FSMBuilderException

FSMBuilderException(FSMBuilderException.ErrorCode, Object...) - Constructor for exception io.hektor.fsm.builder.exceptions.FSMBuilderException

FSMBuilderException.ErrorCode - Enum in io.hektor.fsm.builder.exceptions

There are many different issues that can occur when building the state machine and instead of having individual exceptions for everything, we have these error codes.

FsmImpl<S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.impl

FsmImpl(Object, State[], S, C, D, BiConsumer<S, Object>, TransitionListener<S>) - Constructor for class io.hektor.fsm.impl.FsmImpl

G

getAction() - Method in class io.hektor.fsm.impl.TransitionImpl

getAction() - Method in interface io.hektor.fsm.Transition

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

getConnectedNodes() - Method in class io.hektor.fsm.impl.StateImpl

getConnectedNodes() - Method in interface io.hektor.fsm.State

Retrieve a list of all other states this state is connected to.

getEnterAction() - Method in class io.hektor.fsm.impl.StateImpl

getEnterAction() - Method in interface io.hektor.fsm.State

getErrorCode() - Method in exception io.hektor.fsm.builder.exceptions.FSMBuilderException

getExitAction() - Method in class io.hektor.fsm.impl.StateImpl

getExitAction() - Method in interface io.hektor.fsm.State

getScheduler() - Method in interface io.hektor.fsm.Context

getState() - Method in exception io.hektor.fsm.builder.exceptions.StateBuilderException

Get the state that had already been defined.

getState() - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

getState() - Method in interface io.hektor.fsm.builder.StateBuilder

getState() - Method in interface io.hektor.fsm.FSM

The state in which this FSM currently is.

getState() - Method in class io.hektor.fsm.impl.FsmImpl

getState() - Method in class io.hektor.fsm.impl.StateImpl

getState() - Method in interface io.hektor.fsm.State

Retrieve the enum value of the state.

getStatefulAction() - Method in class io.hektor.fsm.impl.TransitionImpl

getStatefulAction() - Method in interface io.hektor.fsm.Transition

getTemplate() - Method in enum io.hektor.fsm.builder.exceptions.FSMBuilderException.ErrorCode

getToState() - Method in class io.hektor.fsm.impl.TransitionImpl

getToState() - Method in interface io.hektor.fsm.Transition

This Transition represents the transition to this particular state.

getTransformation() - Method in class io.hektor.fsm.impl.TransitionImpl

getTransformation() - Method in interface io.hektor.fsm.Transition

Get the transformation associated with this Transition.

getTransitionsToState(S) - Method in class io.hektor.fsm.impl.StateImpl

Guard<E,C extends Context,D extends Data> - Interface in io.hektor.fsm

A specialized Predicate that accepts three arguments.

GuardAlreadyDefinedException - Exception in io.hektor.fsm.builder.exceptions

Indicates that a guard was already associated with the object (State or Transition)

GuardAlreadyDefinedException() - Constructor for exception io.hektor.fsm.builder.exceptions.GuardAlreadyDefinedException

GuardAlreadyDefinedException(String) - Constructor for exception io.hektor.fsm.builder.exceptions.GuardAlreadyDefinedException

I

ifNull(T, T) - Static method in class io.hektor.fsm.PreConditions

If our reference is null then return a default value instead.

IllegalTransformationOnTransitionException - Exception in io.hektor.fsm.builder.exceptions

You can optionally specify a transformation with your transition but you can only do so if the state you are transitioning to is a so-called transient state.

IllegalTransformationOnTransitionException(Enum, Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.IllegalTransformationOnTransitionException

InitialStateAlreadyDefinedException - Exception in io.hektor.fsm.builder.exceptions

Indicates that you tried to define an initial state twice.

InitialStateAlreadyDefinedException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.InitialStateAlreadyDefinedException

io.hektor.fsm - package io.hektor.fsm

io.hektor.fsm.builder - package io.hektor.fsm.builder

io.hektor.fsm.builder.exceptions - package io.hektor.fsm.builder.exceptions

io.hektor.fsm.builder.impl - package io.hektor.fsm.builder.impl

io.hektor.fsm.impl - package io.hektor.fsm.impl

isFinal(boolean) - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

isFinal() - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

isFinal() - Method in class io.hektor.fsm.impl.StateImpl

isFinal() - Method in interface io.hektor.fsm.State

Check whether or not this state is final.

isInital(boolean) - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

isInital() - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

isInital() - Method in class io.hektor.fsm.impl.StateImpl

isInital() - Method in interface io.hektor.fsm.State

Check whether or not this state is initial.

isStarted() - Method in interface io.hektor.fsm.FSM

isStarted() - Method in class io.hektor.fsm.impl.FsmImpl

isTerminated() - Method in interface io.hektor.fsm.FSM

The FSM is in its terminated state if it has reached the final state.

isTerminated() - Method in class io.hektor.fsm.impl.FsmImpl

isTransient() - Method in class io.hektor.fsm.impl.StateImpl

isTransient() - Method in interface io.hektor.fsm.State

Check whether or not this state is a transient state.

M

match(Object, C, D) - Method in class io.hektor.fsm.impl.TransitionImpl

match(Object, C, D) - Method in interface io.hektor.fsm.Transition

See if the given event is matching this transition.

N

newInstance(Object, C, D, BiConsumer<S, Object>, TransitionListener<S>) - Method in interface io.hektor.fsm.Definition

Create a new FSM based off of this Definition and assign a unique UUID to this state machine.

newInstance(Object, C, D) - Method in interface io.hektor.fsm.Definition

newInstance(Object, C, D) - Method in class io.hektor.fsm.impl.DefinitionImpl

newInstance(Object, C, D, BiConsumer<S, Object>, TransitionListener<S>) - Method in class io.hektor.fsm.impl.DefinitionImpl

O

of(Class<S>) - Static method in interface io.hektor.fsm.FSM

ofContextType(Class<C>) - Method in interface io.hektor.fsm.builder.ContextTypeBuildStep

onEvent(Class<E>) - Method in interface io.hektor.fsm.builder.EventBuildStep

onEvent(Object) - Method in interface io.hektor.fsm.FSM

Deliver an event to this FSM.

onEvent(Object) - Method in class io.hektor.fsm.impl.FsmImpl

onTransition(S, S, Object) - Method in interface io.hektor.fsm.TransitionListener

Will be invoked just before the Transition is executed by the FSM.

P

PreConditions - Class in io.hektor.fsm

Contains common checks for null etc.

R

reStartAndEnter(S) - Method in interface io.hektor.fsm.FSM

Re-start the FSM and enter the specified state.

reStartAndEnter(S) - Method in class io.hektor.fsm.impl.FsmImpl

S

schedule(Supplier<T>, Duration) - Method in interface io.hektor.fsm.Scheduler

Schedule to deliver an event to the FSM at some later point in time.

Scheduler - Interface in io.hektor.fsm

start() - Method in interface io.hektor.fsm.FSM

You must call FSM.start() on the FSM before it can be used.

start() - Method in class io.hektor.fsm.impl.FsmImpl

State<S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm

StateAlreadyDefinedException - Exception in io.hektor.fsm.builder.exceptions

You can only define the same state once.

StateAlreadyDefinedException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.StateAlreadyDefinedException

StateBuilder<S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm.builder

StateBuilderException - Exception in io.hektor.fsm.builder.exceptions

StateBuilderException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.StateBuilderException

StateBuilderException(Enum, String) - Constructor for exception io.hektor.fsm.builder.exceptions.StateBuilderException

StateBuilderImpl<S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.builder.impl

StateBuilderImpl(S) - Constructor for class io.hektor.fsm.builder.impl.StateBuilderImpl

StateBuilderImpl(S, boolean) - Constructor for class io.hektor.fsm.builder.impl.StateBuilderImpl

StateImpl<S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.impl

StateImpl(S, boolean, boolean, boolean, List<Transition<?, S, C, D>>, Optional<Transition<?, S, C, D>>, BiConsumer<C, D>, BiConsumer<C, D>) - Constructor for class io.hektor.fsm.impl.StateImpl

StateNotDefinedException - Exception in io.hektor.fsm.builder.exceptions

If you define a transition from A to B but then you never end up defining the state B, you will get this exception thrown when trying to build the FSM.

StateNotDefinedException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.StateNotDefinedException

T

test(E, C, D) - Method in interface io.hektor.fsm.Guard

Evaluates this predicate on the given arguments.

TransientLoopDetectedException - Exception in io.hektor.fsm.builder.exceptions

If you would be able to specify a transition from a transient state to another transient state (or itself) you will likely end up in a loop.

TransientLoopDetectedException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.TransientLoopDetectedException

TransientStateMissingTransitionException - Exception in io.hektor.fsm.builder.exceptions

Indicates that you defined a transient state but didn't specify any default transitions, which you must for a transient state or you will get stuck in that state and then it wouldn't be a transient state, now would it!

TransientStateMissingTransitionException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.TransientStateMissingTransitionException

Transition<E,S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm

This interface represents the transition between two states.

TransitionBuilder<E,S extends Enum<S>,C extends Context,D extends Data> - Interface in io.hektor.fsm.builder

TransitionBuilderImpl<E,S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.builder.impl

TransitionBuilderImpl(S, Class<E>) - Constructor for class io.hektor.fsm.builder.impl.TransitionBuilderImpl

TransitionBuilderImpl(S, Class<E>, boolean) - Constructor for class io.hektor.fsm.builder.impl.TransitionBuilderImpl

TransitionBuilderImpl(S, Class<E>, boolean, boolean) - Constructor for class io.hektor.fsm.builder.impl.TransitionBuilderImpl

TransitionImpl<E,S extends Enum<S>,C extends Context,D extends Data> - Class in io.hektor.fsm.impl

TransitionImpl(String, S, Class<E>, Predicate<E>, Guard<E, C, D>, Consumer<E>, Action<E, C, D>, Function<E, ?>) - Constructor for class io.hektor.fsm.impl.TransitionImpl

TransitionListener<S extends Enum<S>> - Interface in io.hektor.fsm

TransitionMissingException - Exception in io.hektor.fsm.builder.exceptions

Indicates that you didn't define any transitions for the given state.

TransitionMissingException(Enum) - Constructor for exception io.hektor.fsm.builder.exceptions.TransitionMissingException

transitionTo(S) - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

transitionTo(S) - Method in interface io.hektor.fsm.builder.StateBuilder

transitionToSelf() - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

transitionToSelf() - Method in interface io.hektor.fsm.builder.StateBuilder

V

valueOf(String) - Static method in enum io.hektor.fsm.builder.exceptions.FSMBuilderException.ErrorCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.hektor.fsm.builder.exceptions.FSMBuilderException.ErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAction(Consumer<E>) - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

withAction(Action<E, C, D>) - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

withAction(Consumer<E>) - Method in interface io.hektor.fsm.builder.TransitionBuilder

withAction(Action<E, C, D>) - Method in interface io.hektor.fsm.builder.TransitionBuilder

withDataType(Class<D>) - Method in interface io.hektor.fsm.builder.DataTypeBuildStep

withEnterAction(BiConsumer<C, D>) - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

Register an action that will be executed upon entering this state.

withEnterAction(BiConsumer<C, D>) - Method in interface io.hektor.fsm.builder.StateBuilder

Register an action that will be executed upon entering this state.

withExitAction(BiConsumer<C, D>) - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

Register an action that will be executed upon exiting this state.

withExitAction(BiConsumer<C, D>) - Method in interface io.hektor.fsm.builder.StateBuilder

Register an action that will be executed upon exiting this state.

withFinalState(S) - Method in class io.hektor.fsm.builder.FSMBuilder

withGuard(Predicate<E>) - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

withGuard(Guard<E, C, D>) - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

withGuard(Predicate<E>) - Method in interface io.hektor.fsm.builder.TransitionBuilder

withGuard(Guard<E, C, D>) - Method in interface io.hektor.fsm.builder.TransitionBuilder

withInitialState(S) - Method in class io.hektor.fsm.builder.FSMBuilder

withState(S) - Method in class io.hektor.fsm.builder.FSMBuilder

withStateTimeout() - Method in class io.hektor.fsm.builder.impl.StateBuilderImpl

Set the maximum time we allow to stay in this state.

withStateTimeout() - Method in interface io.hektor.fsm.builder.StateBuilder

Set the maximum time we allow to stay in this state.

withTransformation(Function<E, R>) - Method in class io.hektor.fsm.builder.impl.TransitionBuilderImpl

withTransformation(Function<E, R>) - Method in interface io.hektor.fsm.builder.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.

withTransientState(S) - Method in class io.hektor.fsm.builder.FSMBuilder

A B C D E F G I M N O P R S T V W