DefaultStateMachineService

java.lang.Object
- pl.edu.agh.age.util.fsm.DefaultStateMachineService<S,E>

Type Parameters:

S - the states enumeration.

E - the events enumeration.

All Implemented Interfaces:

FSM<S,E>, StateMachineService<S,E>
```
@ThreadSafe
public final class DefaultStateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
extends java.lang.Object
implements StateMachineService<S,E>
```
A FSM-based service implementation.
These services should be built with StateMachineServiceBuilder.

See Also:

StateMachineServiceBuilder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class DefaultStateMachineService.Dispatcher

Nested Classes
Modifier and Type	Class and Description
`private class`	`DefaultStateMachineService.Dispatcher`

Field Summary

Fields
Modifier and Type	Field and Description
`private E`	`currentEvent`
`private State<S,E>`	`currentState`
`private @Nullable java.util.concurrent.ScheduledFuture<?>`	`dispatcherFuture`
`private @Nullable EventBus`	`eventBus`
`private java.util.Queue<E>`	`eventQueue`
`private java.util.function.Consumer<java.lang.Throwable>`	`exceptionHandler`
`private java.util.Queue<java.lang.Throwable>`	`exceptions`
`private boolean`	`failed`
`private S`	`initialState`
`private static org.slf4j.Logger`	`log`
`private S`	`nextState`
`private @Nullable ListeningScheduledExecutorService`	`service`
`private java.lang.String`	`serviceName`
`private java.util.concurrent.locks.StampedLock`	`stateLock`
`private io.vavr.collection.HashMap<S,State<S,E>>`	`statesMap`
`private boolean`	`synchronous`
`private boolean`	`terminated`

Constructor Summary

Constructors
Constructor and Description

DefaultStateMachineService(StateMachineServiceBuilder<S,E> builder)
Package-protected constructor.

Constructors
Constructor and Description
`DefaultStateMachineService(StateMachineServiceBuilder<S,E> builder)` Package-protected constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`awaitTermination()`
`E`	`currentEvent()`
`S`	`currentState()` Returns the current state of the machine.
`(package private) void`	`drainEvents()`
`(package private) void`	`execute()`
`void`	`failWithError(java.lang.Throwable t)`
`void`	`fire(E event)` Fires an event.
`void`	`forceShutdown()` Shutdowns and cleans up the service even if it have not terminate yet.
`void`	`goTo(S state)`
`private void`	`internalShutdown()`
`private void`	`internalTermination()`
`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.
`private boolean`	`isRunningNotSynchronized()`
`boolean`	`isTerminated()` Tells whether the machine is already terminated.
`void`	`shutdown()` Shutdowns and cleans up the service.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
private static final org.slf4j.Logger log
```
  - serviceName
```
private final java.lang.String serviceName
```
  - initialState
```
private final S extends java.lang.Enum<S> initialState
```
  - synchronous
```
private final boolean synchronous
```
  - statesMap
```
private final io.vavr.collection.HashMap<S extends java.lang.Enum<S>,State<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>> statesMap
```
  - exceptionHandler
```
private final java.util.function.Consumer<java.lang.Throwable> exceptionHandler
```
  - exceptions
```
private final java.util.Queue<java.lang.Throwable> exceptions
```
  - eventQueue
```
private final java.util.Queue<E extends java.lang.Enum<E>> eventQueue
```
  - stateLock
```
private final java.util.concurrent.locks.StampedLock stateLock
```
  - service
```
private final @Nullable ListeningScheduledExecutorService service
```
  - dispatcherFuture
```
private final @Nullable java.util.concurrent.ScheduledFuture<?> dispatcherFuture
```
  - eventBus
```
private final @Nullable EventBus eventBus
```
  - failed
```
private volatile boolean failed
```
  - terminated
```
private volatile boolean terminated
```
  - currentState
```
private State<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>> currentState
```
  - currentEvent
```
private E extends java.lang.Enum<E> currentEvent
```
  - nextState
```
private S extends java.lang.Enum<S> nextState
```
- Constructor Detail
  - DefaultStateMachineService
```
DefaultStateMachineService(StateMachineServiceBuilder<S,E> builder)
```
    Package-protected constructor.
    
    The proper way to build the service is to use the builder StateMachineServiceBuilder.
    
    Parameters:
    
    builder - a builder containing the state machine definition.
- Method Detail
  - fire
```
public void fire(E event)
```
    Description copied from interface: StateMachineService
    
    Fires an event.
    
    Specified by:
    
    fire in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
    
    Parameters:
    
    event - an event to fire.
  - goTo
```
public void goTo(S state)
```
    Specified by:
    
    goTo in interface FSM<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: StateMachineService
    
    Returns whether the service is isRunning.
    
    Specified by:
    
    isRunning in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
  - isRunningNotSynchronized
```
private boolean isRunningNotSynchronized()
```
  - isInState
```
public boolean isInState(S state)
```
    Description copied from interface: StateMachineService
    
    Checks atomically whether the service is in the given state.
    
    Specified by:
    
    isInState in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
    
    Parameters:
    
    state - a state to check.
    
    Returns:
    
    true if the service is in the given state, false otherwise.
  - isTerminated
```
public boolean isTerminated()
```
    Description copied from interface: StateMachineService
    
    Tells whether the machine is already terminated.
    
    Specified by:
    
    isTerminated in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
  - isFailed
```
public boolean isFailed()
```
    Description copied from interface: StateMachineService
    
    Tells whether the machine has failed.
    
    Specified by:
    
    isFailed in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
  - awaitTermination
```
public void awaitTermination()
                      throws java.lang.InterruptedException
```
    Specified by:
    
    awaitTermination in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
    
    Throws:
    
    java.lang.InterruptedException
  - shutdown
```
public void shutdown()
```
    Description copied from interface: StateMachineService
    
    Shutdowns and cleans up the service.
    
    Specified by:
    
    shutdown in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
    
    See Also:
    
    StateMachineService.isTerminated()
  - forceShutdown
```
public void forceShutdown()
```
    Description copied from interface: StateMachineService
    
    Shutdowns and cleans up the service even if it have not terminate yet.
    
    Specified by:
    
    forceShutdown in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
    
    See Also:
    
    StateMachineService.isTerminated(), StateMachineService.shutdown()
  - currentState
```
public S currentState()
```
    Description copied from interface: StateMachineService
    
    Returns the current state of the machine.
    
    Specified by:
    
    currentState in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
  - failWithError
```
public void failWithError(java.lang.Throwable t)
```
    Specified by:
    
    failWithError in interface StateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>
  - currentEvent
```
public E currentEvent()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - drainEvents
```
void drainEvents()
```
  - execute
```
void execute()
```
  - internalTermination
```
private void internalTermination()
```
  - internalShutdown
```
private void internalShutdown()
```

Class DefaultStateMachineService<S extends java.lang.Enum<S>,E extends java.lang.Enum<E>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

serviceName

initialState

synchronous

statesMap

exceptionHandler

exceptions

eventQueue

stateLock

service

dispatcherFuture

eventBus

failed

terminated

currentState

currentEvent

nextState

Constructor Detail

DefaultStateMachineService

Method Detail

fire

goTo

isRunning

isRunningNotSynchronized

isInState

isTerminated

isFailed

awaitTermination

shutdown

forceShutdown

currentState

failWithError

currentEvent

toString

drainEvents

execute

internalTermination

internalShutdown