pl.edu.agh.age.util.fsm

Interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>

Type Parameters:

S - the states enumeration.

E - the events enumeration.

All Superinterfaces:

FSM<S,E>

All Known Implementing Classes:

DefaultStateMachineService

public interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
extends FSM<S,E>

A FSM-based service implementation.

These services should be built with StateMachineServiceBuilder.

See Also:

StateMachineServiceBuilder

Method Summary

Modifier and Type	Method and Description
void	awaitTermination()
S	currentState() Returns the current state of the machine.
void	failWithError(java.lang.Throwable e)
void	fire(E event) Fires an event.
void	forceShutdown() Shutdowns and cleans up the service even if it have not terminate yet.
boolean	isFailed() Tells whether the machine has failed.
boolean	isInState(S state) Checks atomically whether the service is in the given state.
boolean	isRunning() Returns whether the service is isRunning.
boolean	isTerminated() Tells whether the machine is already terminated.
void	shutdown() Shutdowns and cleans up the service.

Methods inherited from interface pl.edu.agh.age.util.fsm.FSM

goTo

Method Detail

fire

void fire(E event)

Fires an event.

Parameters:

event - an event to fire.

isRunning

boolean isRunning()

Returns whether the service is isRunning.

isInState

boolean isInState(S state)

Checks atomically whether the service is in the given state.

Parameters:

state - a state to check.

Returns:

true if the service is in the given state, false otherwise.

currentState

S currentState()

Returns the current state of the machine.

isFailed

boolean isFailed()

Tells whether the machine has failed.

failWithError

void failWithError(java.lang.Throwable e)

isTerminated

boolean isTerminated()

Tells whether the machine is already terminated.

awaitTermination

void awaitTermination()
               throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

shutdown

void shutdown()

Shutdowns and cleans up the service.

Throws:

java.lang.IllegalStateException - if service has not terminated yet.

See Also:

isTerminated()

forceShutdown

void forceShutdown()

Shutdowns and cleans up the service even if it have not terminate yet.

See Also:

isTerminated(), shutdown()