com.github.mvp4g.sema4g.client.command

Class AbstractCommand

java.lang.Object

com.github.mvp4g.sema4g.client.command.AbstractCommand

All Implemented Interfaces:

SeMa4gCommand

Direct Known Subclasses:

AsyncCommand, SyncCommand

public abstract class AbstractCommand
extends Object
implements SeMa4gCommand

AbstractCommand provides base functionality to run a SeMa4g command.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.mvp4g.sema4g.client.command.SeMa4gCommand

SeMa4gCommand.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommand()

Method Summary

Modifier and Type	Method and Description
void	checkCycleDependencies(List<SeMa4gCommand> usedDependencies) Checks if there is a cycle dependencies
SeMa4gCommand	dependingOn(SeMa4gCommand... dependencies) Definies the SeMa4gCommand (one or more) which have to be finished before this command can be executed.
abstract void	execute() Use this method to implement the execution code.
List<SeMa4gCommand>	getDependencies() Returns the list of SeMa4gCommand for this SeMa4gCommand which have to be (successfully) executed before this command can be started
SeMa4g	getExecutionContext() Returns the SeMa4g for this command.
SeMa4gCommand.State	getState() Returns the current SeMa4gCommand.State
void	reset() this method is called to reset the command
void	run() This method is used by the execution context to start the command
void	setExecutionContext(SeMa4g executionContext) Sets the SeMa4g for this command.
void	setState(SeMa4gCommand.State state) Sets the SeMa4gCommand.State of the command
void	signalError() This command can be called to interrupt the execution and start the error behavior.
void	signalFinish() This command can be called to finish an execution and start the next one.
void	startCheckCycleDependencies() starts a cycle dependency check

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommand

protected AbstractCommand()

Method Detail

signalFinish

public void signalFinish()

This command can be called to finish an execution and start the next one.

getDependencies

public List<SeMa4gCommand> getDependencies()

Returns the list of SeMa4gCommand for this SeMa4gCommand which have to be (successfully) executed before this command can be started

Specified by:

getDependencies in interface SeMa4gCommand

Returns:

list of depending commands

getExecutionContext

public SeMa4g getExecutionContext()

Returns the SeMa4g for this command.

Specified by:

getExecutionContext in interface SeMa4gCommand

Returns:

The SeMa4g for this command

getState

public SeMa4gCommand.State getState()

Returns the current SeMa4gCommand.State

Specified by:

getState in interface SeMa4gCommand

Returns:

current state of the command

setExecutionContext

public void setExecutionContext(SeMa4g executionContext)

Sets the SeMa4g for this command.

Specified by:

setExecutionContext in interface SeMa4gCommand

Parameters:

executionContext - the SeMa4g for this command

setState

public void setState(SeMa4gCommand.State state)

Sets the SeMa4gCommand.State of the command

Specified by:

setState in interface SeMa4gCommand

Parameters:

state - the new state

dependingOn

public SeMa4gCommand dependingOn(SeMa4gCommand... dependencies)
                          throws SeMa4gException

Definies the SeMa4gCommand (one or more) which have to be finished before this command can be executed.

Specified by:

dependingOn in interface SeMa4gCommand

Parameters:

dependencies - list of commands which have to be finished, before this command can be started

Returns:

the inistnace of the command

Throws:

SeMa4gException - when a cycle dependency is detected

checkCycleDependencies

public void checkCycleDependencies(List<SeMa4gCommand> usedDependencies)
                            throws SeMa4gException

Checks if there is a cycle dependencies

Specified by:

checkCycleDependencies in interface SeMa4gCommand

Parameters:

usedDependencies - all dependencies for this command

Throws:

SeMa4gException - when a cycle dependency is detected

reset

public void reset()

this method is called to reset the command

Specified by:

reset in interface SeMa4gCommand

run

public void run()

This method is used by the execution context to start the command

Specified by:

run in interface SeMa4gCommand

startCheckCycleDependencies

public void startCheckCycleDependencies()
                                 throws SeMa4gException

starts a cycle dependency check

Specified by:

startCheckCycleDependencies in interface SeMa4gCommand

Throws:

SeMa4gException - in case there is a cycle dependency

signalError

public void signalError()

This command can be called to interrupt the execution and start the error behavior.

Specified by:

signalError in interface SeMa4gCommand

execute

public abstract void execute()

Use this method to implement the execution code.

This method is ionvoked by the framework.