A C D E G H I N P R S T V

A

addGraph(StateGraph<S, L>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

addGraph(StateGraph<S, L>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Adds all of the states and transitions from an existing state graph.

addState(S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

addState(S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Adds a state to the current graph.

addStateListener(StateListener<S, L>) - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

addStateListener(StateListener<S, L>) - Method in interface com.tomgibara.pronto.state.StateEngine

Adds a state listener to this engine.

addStates(Set<S>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

addStates(Set<S>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Adds all the states in the supplied set.

addTransition(StateTransition<S, L>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

addTransition(S, L, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

addTransition(StateTransition<S, L>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Adds a transition to the current graph.

addTransition(S, L, S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Adds a transition to the current graph.

addTransitions(Set<StateTransition<S, L>>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

addTransitions(Set<StateTransition<S, L>>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Adds all the transitions in the supplied set.

C

changeState(S) - Method in interface com.tomgibara.pronto.state.StateActivator

This method is called to indicate that the current state is to be changed directly (ie.

com.tomgibara.pronto.state - package com.tomgibara.pronto.state

com.tomgibara.pronto.state.impl - package com.tomgibara.pronto.state.impl

D

DefaultStateEnginePolicy - Class in com.tomgibara.pronto.state

This StateEnginePolicy implementation is used when no policy has been explicitly set on a state engine.

DefaultStateEnginePolicy() - Constructor for class com.tomgibara.pronto.state.DefaultStateEnginePolicy

E

emptyStateGraph() - Method in class com.tomgibara.pronto.state.impl.StateFactoryImpl

emptyStateGraph() - Method in class com.tomgibara.pronto.state.StateFactory

Creates an empty state graph from which an editor is typically obtained to build any required state graph.

equals(Object) - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

equals(Object) - Method in class com.tomgibara.pronto.state.impl.StateTransitionImpl

G

getGraph() - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

getGraph() - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

getGraph() - Method in interface com.tomgibara.pronto.state.StateEngine

The graph of an engine constrains the states which it may enter and the transitions it may make.

getGraph() - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Creates a new immutable graph instance based on the state of this editor.

getInitialState() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getInitialState() - Method in interface com.tomgibara.pronto.state.StateGraph

The single initial state.

getInitialStates() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getInitialStates() - Method in interface com.tomgibara.pronto.state.StateGraph

An immutable set of the states that are not the target of any transition.

getInstance() - Static method in class com.tomgibara.pronto.state.StateFactory

Should be called to obtain a StateFactory instance.

getLabel() - Method in class com.tomgibara.pronto.state.impl.StateTransitionImpl

getLabel() - Method in interface com.tomgibara.pronto.state.StateTransition

The label with which the transition is decorated.

getMultiPaths(Set<S>, Set<S>, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getMultiPaths(Set<S>, Set<S>, PathType) - Method in interface com.tomgibara.pronto.state.StateGraph

A set containing every possible path (represented as a list of transitions) from any initial state to any terminal state.

getParameter(StateTransition<S, L>) - Method in interface com.tomgibara.pronto.state.StateTransitionParameters

Provides a parameter for a specified transition.

getPath(S, S, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getPath(S, S, PathType) - Method in interface com.tomgibara.pronto.state.StateGraph

A convenience method that may be called to obtain the single existing path from an initial state to a terminal state.

getPaths(S, S, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getPaths(S, S, PathType) - Method in interface com.tomgibara.pronto.state.StateGraph

A set containing every possible path (represented as a list of transitions) from the initial state to the terminal state.

getPolicy() - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

getPolicy() - Method in interface com.tomgibara.pronto.state.StateEngine

The policy under which the engine is operating.

getPossibleStates() - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

getPossibleStates() - Method in interface com.tomgibara.pronto.state.StateEngine

Returns a set of the states which are currently permitted in a call to setState.

getSource() - Method in class com.tomgibara.pronto.state.impl.StateTransitionImpl

getSource() - Method in interface com.tomgibara.pronto.state.StateTransition

The state away from which the transition is directed.

getState() - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

getState() - Method in interface com.tomgibara.pronto.state.StateEngine

The state that this engine is currently in.

getTarget() - Method in class com.tomgibara.pronto.state.impl.StateTransitionImpl

getTarget() - Method in interface com.tomgibara.pronto.state.StateTransition

The state towards which the transition is directed.

getTerminalState() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getTerminalState() - Method in interface com.tomgibara.pronto.state.StateGraph

The single terminal state.

getTerminalStates() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getTerminalStates() - Method in interface com.tomgibara.pronto.state.StateGraph

An immutable set of the states that are not the source of any transition.

getTransition(S, L, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getTransition(S, L, S) - Method in interface com.tomgibara.pronto.state.StateGraph

Obtains the specified state transition from this graph.

getTransitionsMatching(S, L, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

getTransitionsMatching(S, L, S) - Method in interface com.tomgibara.pronto.state.StateGraph

Returns an immutable set of all transitions that match the supplied parameters.

H

hashCode() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

hashCode() - Method in class com.tomgibara.pronto.state.impl.StateTransitionImpl

I

isListenerExceptionLogged() - Method in class com.tomgibara.pronto.state.DefaultStateEnginePolicy

By default, exceptions raised by listeners are not logged.

isListenerExceptionLogged() - Method in interface com.tomgibara.pronto.state.StateEnginePolicy

Specifies whether exceptions raised by listeners, in response to state events, are logged by the implementation.

isListenerExceptionThrown() - Method in class com.tomgibara.pronto.state.DefaultStateEnginePolicy

By default, exceptions raised by listeners are thrown.

isListenerExceptionThrown() - Method in interface com.tomgibara.pronto.state.StateEnginePolicy

Specifies whether exceptions raised by listeners, in response to state events, are thrown on a call to setState or transition.

N

newEditor() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

newEditor() - Method in interface com.tomgibara.pronto.state.StateGraph

Obtains an editor which may be used to edit a copy of this graph.

newEngine(StateGraph<S, L>, StateActivator<S, L, P>) - Method in class com.tomgibara.pronto.state.impl.StateFactoryImpl

newEngine(StateGraph<S, L>, StateActivator<S, L, P>) - Method in class com.tomgibara.pronto.state.StateFactory

Combines a graph and activator to form a new engine.

P

pathTransition(S, L, PathType, StateTransitionParameters<S, L, P>) - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

pathTransition(S, L, PathType, StateTransitionParameters<S, L, P>) - Method in interface com.tomgibara.pronto.state.StateEngine

This method is called to instruct the engine to make a sequence of state transitions.

PathType - Enum in com.tomgibara.pronto.state

A path type is used to constrain the selection of paths from a state graph.

ProntoStateException - Exception in com.tomgibara.pronto.state

Instances of this class are typically thrown when an invalid request is made of a state graph or a state graph editor, or when an state engine transition fails.

ProntoStateException() - Constructor for exception com.tomgibara.pronto.state.ProntoStateException

Constructs a new ProntoStateException.

ProntoStateException(String, Throwable) - Constructor for exception com.tomgibara.pronto.state.ProntoStateException

Constructs a new ProntoStateException.

ProntoStateException(String) - Constructor for exception com.tomgibara.pronto.state.ProntoStateException

Constructs a new ProntoStateException.

ProntoStateException(Throwable) - Constructor for exception com.tomgibara.pronto.state.ProntoStateException

Constructs a new ProntoStateException.

R

removeMultiPaths(Set<S>, Set<S>, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeMultiPaths(Set<S>, Set<S>, PathType) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes every transition that may occur on any path between any specified initial and terminal state.

removePaths(S, S, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removePaths(S, S, PathType) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes every transition that may occur on any path between the specified initial and terminal states.

removeState(S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeState(S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes a state from the current graph.

removeStateListener(StateListener<S, L>) - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

removeStateListener(StateListener<S, L>) - Method in interface com.tomgibara.pronto.state.StateEngine

Removes a previously added state listener from this engine.

removeStates(Set<S>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeStates(Set<S>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the states in the supplied set.

removeTransition(S, L, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeTransition(S, L, S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes a transition from the current graph.

removeTransitions(Set<StateTransition<S, L>>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeTransitions(Set<StateTransition<S, L>>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the transitions in the supplied set.

removeTransitionsLabelled(Set<L>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeTransitionsLabelled(Set<L>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the transitions that have a label in the supplied set.

removeTransitionsMatching(S, L, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeTransitionsMatching(S, L, S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the transitions which match the specified parameters.

removeTransitionsOn(S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

removeTransitionsOn(S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all transitions which are incident on (ie.

retainGraph(StateGraph<S, L>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

retainGraph(StateGraph<S, L>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes from the current graph all of the states and transitions that are not contained within an existing state graph.

retainMultiPaths(Set<S>, Set<S>, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

retainMultiPaths(Set<S>, Set<S>, PathType) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Restricts the current graph to the smallest subgraph such that it contains every transition that occurs on any path from any specified initial state to any specified terminal state.

retainPaths(S, S, PathType) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

retainPaths(S, S, PathType) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Restricts the current graph to the smallest subgraph such that it contains every transition that occurs on any path from the specified initial state to the specified terminal state.

retainStates(Set<S>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

retainStates(Set<S>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the states that are not in the supplied set.

retainTransitions(Set<StateTransition<S, L>>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

retainTransitions(Set<StateTransition<S, L>>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the transitions that are not in the supplied set.

retainTransitionsLabelled(Set<L>) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

retainTransitionsLabelled(Set<L>) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Removes all the transitions that do have a label in the supplied set.

reverse() - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

reverse() - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Reverses the directionality of every transition in the current graph.

S

setPolicy(StateEnginePolicy) - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

setPolicy(StateEnginePolicy) - Method in interface com.tomgibara.pronto.state.StateEngine

Sets the policy under which the state engine will operate.

setState(S) - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

setState(S) - Method in interface com.tomgibara.pronto.state.StateEngine

Puts the engine into a specified state.

StateActivator<S,L,P> - Interface in com.tomgibara.pronto.state

Implementations of this interface are supplied to StateEngine instances for the purpose of performing actions during state transitions.

stateChanged(S) - Method in interface com.tomgibara.pronto.state.StateListener

This methopd is called after the state of an engine has been set directly (ie.

StateEngine<S,L,P> - Interface in com.tomgibara.pronto.state

State Engines manage transitions across a pre-defined graph of allowed states and state transitions.

StateEngineImpl<S,L,P> - Class in com.tomgibara.pronto.state.impl

StateEngineImpl(StateGraph<S, L>, StateActivator<S, L, P>) - Constructor for class com.tomgibara.pronto.state.impl.StateEngineImpl

StateEnginePolicy - Interface in com.tomgibara.pronto.state

Implementations of this interface may be used to control some aspects of state engine operation.

StateFactory - Class in com.tomgibara.pronto.state

This class is used to obtain graphs and engines to manage state transitions.

StateFactory() - Constructor for class com.tomgibara.pronto.state.StateFactory

StateFactoryImpl - Class in com.tomgibara.pronto.state.impl

StateFactoryImpl() - Constructor for class com.tomgibara.pronto.state.impl.StateFactoryImpl

StateGraph<S,L> - Interface in com.tomgibara.pronto.state

A state graph consists of a set of states and a set of transitions between them.

StateGraphEditor<S,L> - Interface in com.tomgibara.pronto.state

Instances of this class may be used to define state graphs.

StateGraphEditorImpl<S,L> - Class in com.tomgibara.pronto.state.impl

StateGraphEditorImpl() - Constructor for class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

StateGraphEditorImpl(StateGraph<S, L>) - Constructor for class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

StateGraphImpl<S,L> - Class in com.tomgibara.pronto.state.impl

StateListener<S,L> - Interface in com.tomgibara.pronto.state

State listeners may be attached to state engines to observe the completion of state changes and state transitions.

states() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

states() - Method in interface com.tomgibara.pronto.state.StateGraph

The set of states in this graph.

StateTransition<S,L> - Interface in com.tomgibara.pronto.state

State transitions are aggregated into graphs by StateGraph objects.

stateTransitioned(StateTransition<S, L>) - Method in interface com.tomgibara.pronto.state.StateListener

This method is called after every successful state transition made by the state engine.

StateTransitionImpl<S,L> - Class in com.tomgibara.pronto.state.impl

StateTransitionImpl(StateTransition<S, L>) - Constructor for class com.tomgibara.pronto.state.impl.StateTransitionImpl

StateTransitionImpl(S, L, S) - Constructor for class com.tomgibara.pronto.state.impl.StateTransitionImpl

StateTransitionParameters<S,L,P> - Interface in com.tomgibara.pronto.state

An implementation of this interface mnay be supplied to StateEngine objects when transitioning along a path.

substituteLabel(L, L) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

substituteLabel(L, L) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Replaces all occurances of one label with another.

substituteLabels(Set<L>, L) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

substituteLabels(Set<L>, L) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Replaces all the labels in a supplied set with a single label.

substituteState(S, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

substituteState(S, S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Replaces all occurances of one state with another.

substituteStates(Set<S>, S) - Method in class com.tomgibara.pronto.state.impl.StateGraphEditorImpl

substituteStates(Set<S>, S) - Method in interface com.tomgibara.pronto.state.StateGraphEditor

Replaces all the states in a supplied set with a single state.

T

toString() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

toString() - Method in class com.tomgibara.pronto.state.impl.StateTransitionImpl

transition(S, L, P) - Method in class com.tomgibara.pronto.state.impl.StateEngineImpl

transition(S, L, P) - Method in interface com.tomgibara.pronto.state.StateEngine

This method is called to instruct the engine to make one (or possibly more) state transitions.

transitions() - Method in class com.tomgibara.pronto.state.impl.StateGraphImpl

transitions() - Method in interface com.tomgibara.pronto.state.StateGraph

An immutable set containing every transition in the graph.

transitionState(StateTransition<S, L>, P) - Method in interface com.tomgibara.pronto.state.StateActivator

This method is called to indicate that the state is being changed via a state transition.

V

valueOf(String) - Static method in enum com.tomgibara.pronto.state.PathType

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

values() - Static method in enum com.tomgibara.pronto.state.PathType

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

A C D E G H I N P R S T V