B C D E F G H I O R S T V W

B

build() - Method in class de.scravy.machina.StateMachineBuilder

Builds a new state machine of target type M from this builder.

C

catchall(S) - Method in class de.scravy.machina.Transition.TransitionBuilder2

If no transition was eligible, fallback to this transition.

classify(E) - Method in interface de.scravy.machina.EventTypeClassifier

Determines the Event Type of an Event.

create() - Static method in class de.scravy.machina.StateMachineBuilder

Creates a new Builder that builds a state machine which accepts any kinds of objects as States, Events, etc.

create(Class<S>, Class<E>) - Static method in class de.scravy.machina.StateMachineBuilder

Creates a new Builder that builds simple state machines.

create(Class<S>, Class<E>, Class<T>) - Static method in class de.scravy.machina.StateMachineBuilder

Creates a new builder that builds state machines with a distinct event type.

create(Class<M>) - Static method in class de.scravy.machina.StateMachineBuilder

Creates a new builder that builds state machines from an interface definition.

createWithContext(Class<S>, Class<E>, Class<C>) - Static method in class de.scravy.machina.StateMachineBuilder

Creates a builder that builds state machines with a computational context.

createWithContext(Class<S>, Class<E>, Class<T>, Class<C>) - Static method in class de.scravy.machina.StateMachineBuilder

Creates a builder that builds state machines with a distinct event type and a computational context.

createWithContext(Class<M>) - Static method in class de.scravy.machina.StateMachineBuilder

Creates a builder that builds state machines with a distinct event type and a computational context from an interface definition.

D

de.scravy.machina - package de.scravy.machina

Stateless Finite State Machines.

DeadEndException - Exception in de.scravy.machina

E

equals(Object) - Method in class de.scravy.machina.ExpressionGuard

equals(Object) - Method in class de.scravy.machina.RunResult

equals(Object) - Method in class de.scravy.machina.Transition

evaluate(E, C) - Method in class de.scravy.machina.ExpressionGuard

evaluate(E, C) - Method in interface de.scravy.machina.Guard

Determines whether the guarded transition is eligible or not.

Events - Class in de.scravy.machina

Static utility methods for dealing with events of all kinds of sorts.

EventTypeClassifier<E,T> - Interface in de.scravy.machina

A functional interface to determine the event type of an event.

EventTypeClassifierException - Exception in de.scravy.machina

EventWithType<T> - Interface in de.scravy.machina

An interface to be implemented by Events that are distinct from their types.

ExpressionGuard<E,C> - Class in de.scravy.machina

A Guard which is defined by an MVEL expression.

ExpressionGuard(String) - Constructor for class de.scravy.machina.ExpressionGuard

Create a condition with an MVEL expression as guard.

F

fallback(S) - Method in class de.scravy.machina.Transition.TransitionBuilder2

If no transition was eligible, fallback to this transition.

fire(E) - Method in interface de.scravy.machina.SimpleStatefulStateMachine

fire(E) - Method in interface de.scravy.machina.StatefulStateMachineWithContext

from(S) - Static method in class de.scravy.machina.Transition

fromReader(Reader) - Static method in class de.scravy.machina.Events

fromStream(InputStream) - Static method in class de.scravy.machina.Events

fromString(String) - Static method in class de.scravy.machina.Events

Build an iterable that returns the characters in a string - useful for parsing strings and treating characters as events.

G

GenericStateMachine - Interface in de.scravy.machina

getCompiledExpression() - Method in class de.scravy.machina.ExpressionGuard

getContext() - Method in class de.scravy.machina.RunResult

getContext() - Method in interface de.scravy.machina.StatefulStateMachineWithContext

getContext() - Method in exception de.scravy.machina.StateMachineException

getContextClass() - Method in interface de.scravy.machina.StateMachineWithContext

Get the class that implements the context of this state machine.

getCurrentState() - Method in exception de.scravy.machina.StateMachineException

getEvent() - Method in exception de.scravy.machina.StateMachineException

getEventClass() - Method in interface de.scravy.machina.StateMachine

Get the class that the events of this state machine inherit from.

getEventsTypesFrom(StateMachine<?, ?, T>) - Static method in class de.scravy.machina.StateMachines

getEventType() - Method in class de.scravy.machina.Transition

getEventTypeClass() - Method in interface de.scravy.machina.StateMachine

Get the class that the event types of this state machine inherit from.

getExpression() - Method in class de.scravy.machina.ExpressionGuard

getFirst() - Method in class de.scravy.machina.RunResult

getFromState() - Method in class de.scravy.machina.Transition

getGuard() - Method in class de.scravy.machina.Transition

getInitialState() - Method in interface de.scravy.machina.StateMachine

getMessage() - Method in enum de.scravy.machina.StateMachineBuilderException.ErrorType

getParent() - Method in interface de.scravy.machina.StateWithParent

getSecond() - Method in class de.scravy.machina.RunResult

getState() - Method in class de.scravy.machina.RunResult

getState() - Method in interface de.scravy.machina.StatefulStateMachine

getStateClass() - Method in interface de.scravy.machina.StateMachine

The class that the states of this state machine inherit from.

getStatesFrom(StateMachine<S, ?, ?>) - Static method in class de.scravy.machina.StateMachines

getStatesMap() - Static method in class de.scravy.machina.StateMachines

getToState() - Method in class de.scravy.machina.Transition

getTransitions() - Method in interface de.scravy.machina.StateMachine

Get the transitions defined in this state machine.

getType() - Method in interface de.scravy.machina.EventWithType

Get the type of this Event.

getUnusedEventTypes() - Static method in class de.scravy.machina.StateMachines

getUnusuedStates() - Static method in class de.scravy.machina.StateMachines

Guard<E,C> - Interface in de.scravy.machina

A functional interface to determine whether a transition is eligible or not.

GuardEvaluationException - Exception in de.scravy.machina

H

hashCode() - Method in class de.scravy.machina.ExpressionGuard

hashCode() - Method in class de.scravy.machina.RunResult

hashCode() - Method in class de.scravy.machina.Transition

I

InvalidExpressionException - Exception in de.scravy.machina

O

on(T, S) - Method in class de.scravy.machina.Transition.TransitionBuilder

on(T, S, String) - Method in class de.scravy.machina.Transition.TransitionBuilder

on(T, S) - Method in class de.scravy.machina.Transition.TransitionBuilder2

on(T, S, String) - Method in class de.scravy.machina.Transition.TransitionBuilder2

onEnter(E, C) - Method in interface de.scravy.machina.StateWithEnterHandler

Executed when a SimpleStateMachine transits into this state.

onExit(E, C) - Method in interface de.scravy.machina.StateWithExitHandler

Executed when a SimpleStateMachine transits away from this state.

onTransition(S, T, S, E, C) - Method in interface de.scravy.machina.TransitionListener

R

run(Iterable<? extends E>) - Method in interface de.scravy.machina.SimpleStateMachine

Executes the state machine with a series of Events.

run(S, E) - Method in interface de.scravy.machina.SimpleStateMachine

Executes the state machine for a single event, starting in the specified state.

run(Iterable<? extends E>, C) - Method in interface de.scravy.machina.StateMachineWithContext

Executes the state machine with a series of Events and a Context.

run(S, E, C) - Method in interface de.scravy.machina.StateMachineWithContext

Executes the state machine for a single event, starting in the specified state.

RunResult<S,C> - Class in de.scravy.machina

S

SimpleStatefulStateMachine<S,E,T> - Interface in de.scravy.machina

SimpleStateMachine<S,E,T> - Interface in de.scravy.machina

A state machine.

StatefulStateMachine<S,E,T> - Interface in de.scravy.machina

StatefulStateMachineWithContext<S,E,T,C> - Interface in de.scravy.machina

StateHandlerException - Exception in de.scravy.machina

StateMachine<S,E,T> - Interface in de.scravy.machina

StateMachineBuilder<S,E,T,C,M extends StateMachine<S,E,T>> - Class in de.scravy.machina

A builder to create SimpleStateMachines.

StateMachineBuilderException - Exception in de.scravy.machina

A RuntimeException thrown by StateMachineBuilder when trying to instantiate a SimpleStateMachine from an invalid definition.

StateMachineBuilderException.ErrorType - Enum in de.scravy.machina

Tge type of this exception.

StateMachineException - Exception in de.scravy.machina

StateMachineListener<S,E,T,C> - Interface in de.scravy.machina

A marker interface for all kinds of listeners that can be attached to a state machine by StateMachineBuilder.withListener(StateMachineListener).

StateMachines - Class in de.scravy.machina

Static utility methods for dealing with state machines.

StateMachines.OutputFormat - Enum in de.scravy.machina

Enumeration of output formats for serializing state machine definitions.

StateMachineWithContext<S,E,T,C> - Interface in de.scravy.machina

A SimpleStateMachine with a computational context.

StateWithEnterHandler<E,C> - Interface in de.scravy.machina

An interface to be implemented by States that handle incoming events.

StateWithExitHandler<E,C> - Interface in de.scravy.machina

An interface to be implemented by States that handle outgoing events.

StateWithParent<S> - Interface in de.scravy.machina

T

toFile(StateMachine<S, ?, T>, StateMachines.OutputFormat, String) - Static method in class de.scravy.machina.StateMachines

Serialize a given state machine definition as a file.

toFile(StateMachine<S, ?, T>, StateMachines.OutputFormat, File) - Static method in class de.scravy.machina.StateMachines

Serialize a given state machine definition as a file.

toPath(StateMachine<S, ?, T>, StateMachines.OutputFormat, Path) - Static method in class de.scravy.machina.StateMachines

Serialize a given state machine definition as a file.

toStream(StateMachine<S, ?, T>, StateMachines.OutputFormat, OutputStream) - Static method in class de.scravy.machina.StateMachines

Serialize a given state machine definition to a stream.

toString() - Method in class de.scravy.machina.ExpressionGuard

toString() - Method in class de.scravy.machina.RunResult

toString(StateMachine<S, ?, T>, StateMachines.OutputFormat) - Static method in class de.scravy.machina.StateMachines

Serialize a given StateMachine definition to a String.

toString(StateMachine<S, ?, T>, StateMachines.OutputFormat, StringBuilder) - Static method in class de.scravy.machina.StateMachines

Serialize a given StateMachine definition to a StringBuilder.

toString() - Method in class de.scravy.machina.Transition

toWriter(StateMachine<S, ?, T>, StateMachines.OutputFormat, Writer) - Static method in class de.scravy.machina.StateMachines

Serialize a given state machine definition to a writer.

Transition<S,T> - Class in de.scravy.machina

A value class that represents a transition, with an optional guard attached.

Transition(S, T, S) - Constructor for class de.scravy.machina.Transition

Transition(S, T, S, Guard<?, ?>) - Constructor for class de.scravy.machina.Transition

Transition.TransitionBuilder<S> - Class in de.scravy.machina

A TransitionBuilder that builds transitions.

Transition.TransitionBuilder2<S,T> - Class in de.scravy.machina

A TransitionBuilder that builds transitions.

TransitionListener<S,E,T,C> - Interface in de.scravy.machina

A transition listener is invoked after a state is exited and before a new state is entered.

V

valueOf(String) - Static method in enum de.scravy.machina.StateMachineBuilderException.ErrorType

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

valueOf(String) - Static method in enum de.scravy.machina.StateMachines.OutputFormat

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

values() - Static method in enum de.scravy.machina.StateMachineBuilderException.ErrorType

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

values() - Static method in enum de.scravy.machina.StateMachines.OutputFormat

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

W

withCatchall(S, S) - Method in class de.scravy.machina.StateMachineBuilder

withEventTypeClassifier(EventTypeClassifier<E, T>) - Method in class de.scravy.machina.StateMachineBuilder

withFallback(S, S) - Method in class de.scravy.machina.StateMachineBuilder

withInitialState(S) - Method in class de.scravy.machina.StateMachineBuilder

withListener(StateMachineListener<S, E, T, C>) - Method in class de.scravy.machina.StateMachineBuilder

Define a new listener.

withState() - Method in interface de.scravy.machina.SimpleStateMachine

withState(S) - Method in interface de.scravy.machina.SimpleStateMachine

withState(C) - Method in interface de.scravy.machina.StateMachineWithContext

withState(C, S) - Method in interface de.scravy.machina.StateMachineWithContext

withTransition(S, T, S) - Method in class de.scravy.machina.StateMachineBuilder

Define a new transition.

withTransition(S, T, S, String) - Method in class de.scravy.machina.StateMachineBuilder

Define a new transition guarded by an MVEL expression.

withTransition(S, T, S, Guard<E, C>) - Method in class de.scravy.machina.StateMachineBuilder

Define a new transition guarded by a Guard.

withTransitions(Transition.TransitionBuilder2<S, T>...) - Method in class de.scravy.machina.StateMachineBuilder

Defines a bunch of new Transitions using Transition.from(Object).

B C D E F G H I O R S T V W