A F G I N O R S T

A

AbstractState<T extends InputSource> - Class in net.sourceforge.aqueduct.state

Base class for State implementations.

AbstractState(String, boolean) - Constructor for class net.sourceforge.aqueduct.state.AbstractState

addStateEventListener(S, StateEventListener<I>) - Method in class net.sourceforge.aqueduct.StateMachine

Registers a StateEventListener to receive transition event notifications for the indicated State.

addStateTransition(S, String, S) - Method in class net.sourceforge.aqueduct.StateMachineDescription.Builder

addTransition(String, S) - Method in class net.sourceforge.aqueduct.StateMachineDescription.Builder

addTransitionPattern(Pattern, String) - Method in class net.sourceforge.aqueduct.state.RegexState.Builder

addTransitionPattern(String, String) - Method in class net.sourceforge.aqueduct.state.RegexState.Builder

F

findNextState(S, String) - Method in class net.sourceforge.aqueduct.StateMachineDescription

Given a State and a transition name, returns the corresponding State that would be transitioned to.

findStateById(String) - Method in class net.sourceforge.aqueduct.StateMachineDescription

Returns the State object with the provided id value.

findTransitionName(String) - Method in class net.sourceforge.aqueduct.state.RegexState

Iterates over the regular expressions in this object's regexTransitions map, testing the provided String against each expression.

G

getCurrentState() - Method in class net.sourceforge.aqueduct.StateMachine

getCurrentString() - Method in class net.sourceforge.aqueduct.inputsource.StringSequenceInputSource

Returns the String returned by the last call to nextString().

getId() - Method in class net.sourceforge.aqueduct.state.AbstractState

getId() - Method in interface net.sourceforge.aqueduct.State

Returns this State's identifier.

getInitialState() - Method in class net.sourceforge.aqueduct.StateMachineDescription

Returns the starting State described by this StateMachineDescription.

getInputSource() - Method in class net.sourceforge.aqueduct.StateEvent

The InputSource provided in the state transition during the StateEventListener event.

getState() - Method in class net.sourceforge.aqueduct.StateEvent

The State involved in the StateEventListener event.

goToNextState() - Method in class net.sourceforge.aqueduct.StateMachine

Performs a single state transition and fires the requisite StateEventListener event handler methods.

goToStateById(String) - Method in class net.sourceforge.aqueduct.StateMachine

Transitions this StateMachine to the state named by the id parameter.

I

InputSource - Interface in net.sourceforge.aqueduct

Marker interface for an object that supplies a State with the contextual information it needs to choose a transition name.

InvalidStateTransitionException - Exception in net.sourceforge.aqueduct

Thrown when a StateMachine attempts to transition to a next state, but the current State returns an unknown transition name.

InvalidStateTransitionException(String) - Constructor for exception net.sourceforge.aqueduct.InvalidStateTransitionException

isGoToStateByIdAllowed() - Method in class net.sourceforge.aqueduct.StateMachineDescription

Returns true if StateMachine objects based on this StateMachineDescription may be set directly to a state by providing a state id.

isStopState() - Method in class net.sourceforge.aqueduct.state.AbstractState

isStopState() - Method in interface net.sourceforge.aqueduct.State

Indicates to a StateMachine that the runUntilStopState() method should stop executing state transitions.

N

net.sourceforge.aqueduct - package net.sourceforge.aqueduct

net.sourceforge.aqueduct.inputsource - package net.sourceforge.aqueduct.inputsource

net.sourceforge.aqueduct.state - package net.sourceforge.aqueduct.state

newRegexState() - Method in class net.sourceforge.aqueduct.state.RegexState.Builder

Returns a new RegexState instance based on the values passed into this Builder.

newStateMachine(I) - Method in class net.sourceforge.aqueduct.StateMachineDescription

Creates a new StateMachine instance that uses this StateMachineDescription to define its states and transitions.

newStateMachineDescription() - Method in class net.sourceforge.aqueduct.StateMachineDescription.Builder

Returns a new StateMachineDescription instance based on the values passed into this Builder.

nextStartingState(S) - Method in class net.sourceforge.aqueduct.StateMachineDescription.Builder

nextString() - Method in class net.sourceforge.aqueduct.inputsource.StringSequenceInputSource

Returns the next String from the sequence.

nextTransition(T) - Method in interface net.sourceforge.aqueduct.State

Uses values from the provided InputSource to determine the StateMachine's next transition.

nextTransition(StringSequenceInputSource) - Method in class net.sourceforge.aqueduct.state.RegexState

Returns the transition name that corresponds to the next String in the provided StringSequenceInputSource.

nextTransition(T) - Method in class net.sourceforge.aqueduct.state.TerminalState

Returns the next transition name.

O

onEnterState(StateEvent<T>) - Method in interface net.sourceforge.aqueduct.StateEventListener

Fired when a StateMachine transitions to a listened-to State.

onExitState(StateEvent<T>) - Method in interface net.sourceforge.aqueduct.StateEventListener

Fired when a StateMachine transitions away from a listened-to State.

R

RegexState - Class in net.sourceforge.aqueduct.state

State implementation that uses regular expression matching to select the next transition.

RegexState(String, boolean, Map<Pattern, String>, String) - Constructor for class net.sourceforge.aqueduct.state.RegexState

RegexState.Builder - Class in net.sourceforge.aqueduct.state

Convenience class that simplifies the code required to create a RegexState instance.

RegexState.Builder() - Constructor for class net.sourceforge.aqueduct.state.RegexState.Builder

removeStateEventListener(S, StateEventListener<I>) - Method in class net.sourceforge.aqueduct.StateMachine

Unregisters a StateEventListener that is receiving transition event notifications for the provided State.

runUntilStopState() - Method in class net.sourceforge.aqueduct.StateMachine

Calls goToNextState() until currentState.isStopState() returns true or until the stopRunningUntilStopState() method is called.

S

setDefaultTransition(String) - Method in class net.sourceforge.aqueduct.state.RegexState.Builder

setGoToStateByIdAllowed(boolean) - Method in class net.sourceforge.aqueduct.StateMachineDescription.Builder

setId(String) - Method in class net.sourceforge.aqueduct.state.RegexState.Builder

setInitialState(S) - Method in class net.sourceforge.aqueduct.StateMachineDescription.Builder

setStopState(boolean) - Method in class net.sourceforge.aqueduct.state.RegexState.Builder

State<T extends InputSource> - Interface in net.sourceforge.aqueduct

A state in the state machine.

StateEvent<T extends InputSource> - Class in net.sourceforge.aqueduct

Message sent to active StateEventListeners.

StateEvent(State<T>, T) - Constructor for class net.sourceforge.aqueduct.StateEvent

StateEventListener<T extends InputSource> - Interface in net.sourceforge.aqueduct

Interface to be used by objects wishing to be notified when one or more given states encounters a transition event.

StateMachine<S extends State<I>,I extends InputSource> - Class in net.sourceforge.aqueduct

Maintains the current state and InputSource used by a particular execution of a StateMachineDescription.

StateMachine(StateMachineDescription<S, I>, I) - Constructor for class net.sourceforge.aqueduct.StateMachine

StateMachineDescription<S extends State<I>,I extends InputSource> - Class in net.sourceforge.aqueduct

Contains State objects and the transitions between them.

StateMachineDescription(S, Map<S, Map<String, S>>, boolean) - Constructor for class net.sourceforge.aqueduct.StateMachineDescription

StateMachineDescription.Builder<S extends State<I>,I extends InputSource> - Class in net.sourceforge.aqueduct

Convenience class that simplifies the code required to create a StateMachineDescription.

StateMachineDescription.Builder() - Constructor for class net.sourceforge.aqueduct.StateMachineDescription.Builder

stopRunningUntilStopState() - Method in class net.sourceforge.aqueduct.StateMachine

Sets a flag to break the loop in runUntilStopState().

StringSequenceInputSource - Class in net.sourceforge.aqueduct.inputsource

An InputSource that provides a sequence of Strings as inputs to a StateMachine.

StringSequenceInputSource(List<String>) - Constructor for class net.sourceforge.aqueduct.inputsource.StringSequenceInputSource

StringSequenceInputSource(String...) - Constructor for class net.sourceforge.aqueduct.inputsource.StringSequenceInputSource

StringSequenceState - Interface in net.sourceforge.aqueduct.state

T

TerminalState<T extends InputSource> - Class in net.sourceforge.aqueduct.state

Represents a terminal state in a state machine.

TerminalState(String) - Constructor for class net.sourceforge.aqueduct.state.TerminalState

toString() - Method in class net.sourceforge.aqueduct.state.AbstractState

A F G I N O R S T