net.eduvax.util

Class AStateMachineCommand<TMachineSt,TMachineEv,TEv extends Event>

java.lang.Object

net.eduvax.util.AStateMachineCommand<TMachineSt,TMachineEv,TEv>

All Implemented Interfaces:

java.lang.Runnable

public abstract class AStateMachineCommand<TMachineSt,TMachineEv,TEv extends Event>
extends java.lang.Object
implements java.lang.Runnable

Command controled by state machine. Command can be run if related state machine state allows it. State machine state may change after command is done.

Field Summary

Fields

Modifier and Type	Field and Description
private ErrorHandler	_errHandler Error handler.
private Handler<TEv>	_evHandler Event handler.
private EventProducer<TEv>	_evProducer Event generator.
private TMachineEv	_koEv Event to report command failure.
private TMachineEv	_okEv Event to report command succes.
private TMachineEv	_startEv Event to report command start.
private StateMachine<TMachineSt,TMachineEv>	_stateMachine State machine controlling this command execution.

Constructor Summary

Constructors

Constructor and Description
AStateMachineCommand(StateMachine<TMachineSt,TMachineEv> stateMachine, Handler<TEv> evHandler, EventProducer<TEv> evProducer, ErrorHandler errHandler, TMachineEv startEv, TMachineEv okEv, TMachineEv koEv) Create new command.

Method Summary

Methods

Modifier and Type	Method and Description
protected ErrorHandler	getErrHandler() Get error handler.
abstract void	oRun() Command entry point.
void	run() Runnable implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_startEv

private TMachineEv _startEv

Event to report command start.

_okEv

private TMachineEv _okEv

Event to report command succes.

_koEv

private TMachineEv _koEv

Event to report command failure.

_stateMachine

private StateMachine<TMachineSt,TMachineEv> _stateMachine

State machine controlling this command execution.

_evProducer

private EventProducer<TEv extends Event> _evProducer

Event generator.

_errHandler

private ErrorHandler _errHandler

Error handler.

_evHandler

private Handler<TEv extends Event> _evHandler

Event handler.

Constructor Detail

AStateMachineCommand

public AStateMachineCommand(StateMachine<TMachineSt,TMachineEv> stateMachine,
                    Handler<TEv> evHandler,
                    EventProducer<TEv> evProducer,
                    ErrorHandler errHandler,
                    TMachineEv startEv,
                    TMachineEv okEv,
                    TMachineEv koEv)

Create new command. The automata checks if command can execute regarding its internal state and the transition linked to command start. The end error is determined by apparition of error during execution. The automata's state is updated according the end transition. When same transition is given for start, succeed and fail events, no transition is applied at command end.

Parameters:

stateMachine - execution controler automata.

evHandler - target for all automated events created during command execution.

evProducer - event generator to use to create events.

errHandler - error handler.

startEv - transition linked to command start.

okEv - transition linked to command succes.

koEv - transition linked to command failure.

Method Detail

oRun

public abstract void oRun()

Command entry point. Override this method to define command job.
warning: don't override run() to preserv default state machine management.

run

public void run()

Runnable implementation. warning: don't override run(), override oRun() instead to define the command job.

Specified by:

run in interface java.lang.Runnable

getErrHandler

protected ErrorHandler getErrHandler()

Get error handler. Use to check if error appeared during command execution.

Returns:

the error handler.