C E F G I L N P S

C

com.tomgibara.pronto.control - package com.tomgibara.pronto.control

com.tomgibara.pronto.control.impl - package com.tomgibara.pronto.control.impl

ControlFactory - Class in com.tomgibara.pronto.control

Instances of this class are responsible for creating Controller objects from ControllerSettings interface.

ControlFactory() - Constructor for class com.tomgibara.pronto.control.ControlFactory

ControlFactoryImpl - Class in com.tomgibara.pronto.control.impl

The standard implementation of the ControlFactory interface.

ControlFactoryImpl() - Constructor for class com.tomgibara.pronto.control.impl.ControlFactoryImpl

Controller<S,L,P> - Interface in com.tomgibara.pronto.control

A Controller manipulates a state engine in response to events in an application's environment.

ControllerImpl<S,L,P> - Class in com.tomgibara.pronto.control.impl

The standard implementation of the Controller interface.

ControllerImpl(StateEngine<S, L, P>, EngineControlAdapter<S, L, P>) - Constructor for class com.tomgibara.pronto.control.impl.ControllerImpl

ControllerSettings - Interface in com.tomgibara.pronto.control

The interface used as the base interface for all controller settings interfaces.

E

EngineControlAdapter<S,L,P> - Interface in com.tomgibara.pronto.control

Implementations of this interface provide a controller with string representations of a state engine's labels.

F

FileControllerPart<S,L,P> - Class in com.tomgibara.pronto.control.impl

A ControllerPart implementation that provides functionality for the FileControllerSettings interface.

FileControllerPart(ControllerImpl<S, L, P>, FileControllerSettings) - Constructor for class com.tomgibara.pronto.control.impl.FileControllerPart

Creates a new FileControllerPart.

FileControllerSettings - Interface in com.tomgibara.pronto.control

Implementations of this interface may be passed to a control factory to create a controller that responds to instructions in a file.

G

getAdapter() - Method in interface com.tomgibara.pronto.control.Controller

The adapter that is being used by the controller to mediate external events and the state graph.

getAdapter() - Method in class com.tomgibara.pronto.control.impl.ControllerImpl

getCheckPeriod() - Method in interface com.tomgibara.pronto.control.FileControllerSettings

The approximate time between successive checks on the file.

getCheckPeriod() - Method in interface com.tomgibara.pronto.control.StdinControllerSettings

The approximate time between successive checks for new input on STDIN.

getController() - Method in class com.tomgibara.pronto.control.impl.FileControllerPart

getController() - Method in class com.tomgibara.pronto.control.impl.SignalControllerPart

getController() - Method in class com.tomgibara.pronto.control.impl.StdinControllerPart

getEngine() - Method in interface com.tomgibara.pronto.control.Controller

The engine through which this controller operates.

getEngine() - Method in class com.tomgibara.pronto.control.impl.ControllerImpl

getFile() - Method in interface com.tomgibara.pronto.control.FileControllerSettings

The file that will be checked for control instructions.

getInstance() - Static method in class com.tomgibara.pronto.control.ControlFactory

Should be called to obtain a ConfigFactory instance.

I

isFileDeleted() - Method in interface com.tomgibara.pronto.control.FileControllerSettings

Whether the file is deleted after its control instructions have been read and executed.

isInteractive() - Method in interface com.tomgibara.pronto.control.StdinControllerSettings

Whether the input on STDIN is user interactive.

isOlderIgnored() - Method in interface com.tomgibara.pronto.control.FileControllerSettings

Whether changes in a file's last-modified that move 'back in time' should be ignored for the purpose of identifying changes in the file.

isPreexistingIgnored() - Method in interface com.tomgibara.pronto.control.FileControllerSettings

Whether a file that already existed the first time it was checked should be ignored until the file is updated.

isSettingsIfaceSupported(Class<? extends ControllerSettings>) - Method in class com.tomgibara.pronto.control.ControlFactory

Indicates whether the interface supplied is recognized by this factory.

isSettingsIfaceSupported(Class<? extends ControllerSettings>) - Method in class com.tomgibara.pronto.control.impl.ControlFactoryImpl

L

labelFromName(String) - Method in interface com.tomgibara.pronto.control.EngineControlAdapter

Returns the label with the supplied name.

N

nameFromLabel(L) - Method in interface com.tomgibara.pronto.control.EngineControlAdapter

Provides a string representation of a supplied label.

newController(ControllerSettings, StateEngine<S, L, P>, EngineControlAdapter<S, L, P>) - Method in class com.tomgibara.pronto.control.ControlFactory

Constructs a new controller.

newController(ControllerSettings, StateEngine<S, L, P>, EngineControlAdapter<S, L, P>) - Method in class com.tomgibara.pronto.control.impl.ControlFactoryImpl

P

parseParameter(String) - Method in interface com.tomgibara.pronto.control.EngineControlAdapter

Returns a parameter string that is supplied to the controller into a parameter object that can be used to perform transitions.

ProntoControlException - Exception in com.tomgibara.pronto.control

Instances of this class are thrown from methods to indicate that a controller has malfunctioned.

ProntoControlException() - Constructor for exception com.tomgibara.pronto.control.ProntoControlException

Constructs a new ProntoControlException.

ProntoControlException(String, Throwable) - Constructor for exception com.tomgibara.pronto.control.ProntoControlException

Constructs a new ProntoControlException.

ProntoControlException(String) - Constructor for exception com.tomgibara.pronto.control.ProntoControlException

Constructs a new ProntoControlException.

ProntoControlException(Throwable) - Constructor for exception com.tomgibara.pronto.control.ProntoControlException

Constructs a new ProntoControlException.

S

SignalControllerPart<S,L,P> - Class in com.tomgibara.pronto.control.impl

A ControllerPart implementation that provides functionality for the SignalControllerSettings interface.

SignalControllerPart(ControllerImpl<S, L, P>, SignalControllerSettings) - Constructor for class com.tomgibara.pronto.control.impl.SignalControllerPart

Creates a new SignalControllerPart.

SignalControllerSettings - Interface in com.tomgibara.pronto.control

Implementations of this interface may be passed to a control factory to create a controller that responds to a shutdown of the JVM.

start() - Method in interface com.tomgibara.pronto.control.Controller

Starts the controller.

start() - Method in class com.tomgibara.pronto.control.impl.ControllerImpl

start() - Method in class com.tomgibara.pronto.control.impl.FileControllerPart

Uses the shared pronto executor to schedule periodic file checks.

start() - Method in class com.tomgibara.pronto.control.impl.SignalControllerPart

Causes a shutdown hook to be registered for the purpose of performing termination state transitions.

start() - Method in class com.tomgibara.pronto.control.impl.StdinControllerPart

Uses the shared pronto executor to schedule periodic checks on STDIN.

StdinControllerPart<S,L,P> - Class in com.tomgibara.pronto.control.impl

A ControllerPart implementation that provides functionality for the StdinControllerSettings interface.

StdinControllerPart(ControllerImpl<S, L, P>, StdinControllerSettings) - Constructor for class com.tomgibara.pronto.control.impl.StdinControllerPart

Creates a new StdinControllerPart.

StdinControllerSettings - Interface in com.tomgibara.pronto.control

Implementations of this interface may be passed to a control factory to create a controller that responds to instructions from STDIN (System.in).

stop(long) - Method in interface com.tomgibara.pronto.control.Controller

Stops the controller.

stop(long) - Method in class com.tomgibara.pronto.control.impl.ControllerImpl

stop(long) - Method in class com.tomgibara.pronto.control.impl.FileControllerPart

Requests that the Pronto executor stops any future file checks and then waits (subject to the supplied timeout) until the ceasation of any ongoing checking has been confirmed.

stop(long) - Method in class com.tomgibara.pronto.control.impl.SignalControllerPart

If a shutdown hook as been registered, the hook is deregistered and the method returns immediately unless JVM shutdown is in progress in which case the method blocks (subject to the specified timeout) until termination state transitions have been completed.

stop(long) - Method in class com.tomgibara.pronto.control.impl.StdinControllerPart

Requests that the Pronto executor stops any future STDIN checks and then waits (subject to the supplied timeout) until the ceasation of any ongoing checking has been confirmed.

C E F G I L N P S