org.jrebirth.af.core.command

Class AbstractMultiCommand<WB extends WaveBean>

java.lang.Object

org.jrebirth.af.core.link.AbstractReady<R>

org.jrebirth.af.core.link.AbstractWaveReady<Command>

org.jrebirth.af.core.command.AbstractBaseCommand<WB>

org.jrebirth.af.core.command.AbstractMultiCommand<WB>

Type Parameters:

WB - The WaveBean type used for this command (by default you can use the WaveBean interface)

All Implemented Interfaces:

Command, CommandBean<WB>, MultiCommand<WB>, FacadeReady<Command>, WaveReady<Command>, CommandReady, LinkMessages, ModelReady, ServiceReady, MessageContainer, WaveListener

Direct Known Subclasses:

DefaultMultiBeanCommand

public abstract class AbstractMultiCommand<WB extends WaveBean>
extends AbstractBaseCommand<WB>
implements MultiCommand<WB>, WaveListener

The class AbstractMultiCommand. The base multi command class for Internal commands.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicBoolean	cancelRequested Cancellation has been requested.
private List<Class<? extends Command>>	commandList The list of command that will be chained.
private int	commandRunIndex The index of the last command performed.
private static Boolean	DEFAULT_SEQUENTIAL_VALUE The default sequential value, could be overridden by annotation or constructor argument.
private List<Wave>	pendingWaves The list of pending waves triggered by each command when launched in parallel.
private AtomicBoolean	running The command is running.
private boolean	sequential Flag that indicate if commands must be run sequentially(true) or in parallel(false).
private Wave	waveSource The source wave that trigger this command.

Fields inherited from class org.jrebirth.af.core.link.AbstractWaveReady

PROCESS_WAVE_METHOD_NAME

Fields inherited from interface org.jrebirth.af.core.link.LinkMessages

CALL_ANNOTATED_METHOD_ERROR, COMMAND_NOT_FOUND_ERROR, COMMAND_NOT_FOUND_MESSAGE, COMPONENT_INJECTION_FAILURE, CUSTOM_METHOD_NOT_FOUND, LISTEN_WAVE_TYPE, MODEL_NOT_FOUND_ERROR, MODEL_NOT_FOUND_MESSAGE, NO_WAVE_LISTENER, NOTIFIER_CONSUMES, SEND_WAVE, SERVICE_NOT_FOUND_ERROR, SERVICE_NOT_FOUND_MESSAGE, UNLISTEN_WAVE_TYPE, USE_DEFAULT_WAVE_HANDLER, WAVE_BEAN_CREATION_ERROR, WAVE_DISPATCH_ERROR, WAVE_HANDLING_ERROR, WAVE_LOST, WAVE_LOST_CONTEXT, WAVE_SENDING_ERROR

Constructor Summary

Constructors

Constructor and Description
AbstractMultiCommand(boolean sequential) Default Constructor.
AbstractMultiCommand(RunType runInto) Default Constructor.
AbstractMultiCommand(RunType runInto, boolean sequential) Default Constructor.
AbstractMultiCommand(RunType runInto, RunnablePriority priority, boolean sequential) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommandClass(Class<? extends Command> commandClass) Add a command to the queue.
void	afterPerform(Wave wave) Actions to perform after the command into the executor thread.
void	beforePerform(Wave wave) Actions to perform before the command into the executor thread.
protected abstract void	initCommand() Custom method used to initialize the command.
private void	initSequential(Boolean sequential) Define the sequential value.
boolean	isRunning()
protected boolean	isSequential()
protected abstract void	manageSubCommand() This method must be used to add sub command by calling addCommandClass(Class).
protected void	perform(Wave wave) Perform the command code.
void	ready() The component is now ready to do custom initialization tasks.
protected void	setSequential(boolean sequential)
void	waveCancelled(Wave wave) The wave has just been cancelled.
void	waveConsumed(Wave wave) The wave has just been consumed.
void	waveCreated(Wave wave) The wave has just been created.
void	waveDestroyed(Wave wave) The wave has just been destroyed.
void	waveFailed(Wave wave) The wave processing has failed.
void	waveProcessed(Wave wave) The wave is being processed.
void	waveSent(Wave wave) The wave has just been sent to the notifier.

Methods inherited from class org.jrebirth.af.core.command.AbstractBaseCommand

finalize, fireConsumed, fireFailed, getRunInto, getRunnablePriority, getWaveBean, innerRun, processWave, run, run

Methods inherited from class org.jrebirth.af.core.link.AbstractWaveReady

attachUi, callCommand, callCommand, getReturnCommand, getReturnWaveType, listen, listen, listen, registerCallback, registerCallback, registerCallback, release, returnData, sendWave, sendWave, setup, unlisten

Methods inherited from class org.jrebirth.af.core.link.AbstractReady

getCommand, getFirstKeyPart, getKey, getListKeyPart, getLocalFacade, getModel, getSecondKeyPart, getService, getThirdKeyPart, setKey, setLocalFacade

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.core.command.CommandBean

getWaveBean

Methods inherited from interface org.jrebirth.af.core.command.Command

run, run

Methods inherited from interface org.jrebirth.af.core.facade.WaveReady

getReturnCommand, getReturnWaveType, listen, listen, listen, registerCallback, registerCallback, registerCallback, sendWave, sendWave, unlisten

Methods inherited from interface org.jrebirth.af.core.facade.FacadeReady

getKey, getLocalFacade, release, setKey, setLocalFacade, setup

Methods inherited from interface org.jrebirth.af.core.link.ModelReady

attachUi, getModel

Methods inherited from interface org.jrebirth.af.core.link.ServiceReady

getService, returnData

Methods inherited from interface org.jrebirth.af.core.link.CommandReady

callCommand, callCommand, getCommand

Field Detail

DEFAULT_SEQUENTIAL_VALUE

private static final Boolean DEFAULT_SEQUENTIAL_VALUE

The default sequential value, could be overridden by annotation or constructor argument.

running

private final AtomicBoolean running

The command is running.

commandList

private final List<Class<? extends Command>> commandList

The list of command that will be chained.

pendingWaves

private final List<Wave> pendingWaves

The list of pending waves triggered by each command when launched in parallel.

sequential

private boolean sequential

Flag that indicate if commands must be run sequentially(true) or in parallel(false).

commandRunIndex

private int commandRunIndex

The index of the last command performed.

waveSource

private Wave waveSource

The source wave that trigger this command.

cancelRequested

private final AtomicBoolean cancelRequested

Cancellation has been requested.

Constructor Detail

AbstractMultiCommand

public AbstractMultiCommand(RunType runInto)

Default Constructor.

Parameters:

runInto - The run into thread type

AbstractMultiCommand

public AbstractMultiCommand(boolean sequential)

Default Constructor.

Parameters:

sequential - indicate if commands must be run sequentially(true) or in parallel(false)

AbstractMultiCommand

public AbstractMultiCommand(RunType runInto,
                    boolean sequential)

Default Constructor.

Parameters:

runInto - The run into thread type

sequential - indicate if commands must be run sequentially(true) or in parallel(false)

AbstractMultiCommand

public AbstractMultiCommand(RunType runInto,
                    RunnablePriority priority,
                    boolean sequential)

Default Constructor.

Parameters:

runInto - The run into thread type

priority - the runnable priority

sequential - indicate if commands must be run sequentially(true) or in parallel(false)

Method Detail

initSequential

private void initSequential(Boolean sequential)

Define the sequential value. It will try to load the annotation value, then the parameter given to constructor. If none of them have been used the default false value will be used.

Parameters:

sequential - the constructor parameter

isSequential

protected boolean isSequential()

Returns:

Returns the sequential.

setSequential

protected void setSequential(boolean sequential)

Parameters:

sequential - The sequential to set.

ready

public final void ready()
                 throws CoreException

The component is now ready to do custom initialization tasks.

Specified by:

ready in class AbstractWaveReady<Command>

Throws:

CoreException - if an error occurred

initCommand

protected abstract void initCommand()

Custom method used to initialize the command. Called into JIT by ready method.

manageSubCommand

protected abstract void manageSubCommand()

This method must be used to add sub command by calling addCommandClass(Class).

beforePerform

public void beforePerform(Wave wave)

Actions to perform before the command into the executor thread.

Specified by:

beforePerform in class AbstractBaseCommand<WB extends WaveBean>

Parameters:

wave - the wave that triggered this command

afterPerform

public void afterPerform(Wave wave)

Actions to perform after the command into the executor thread.

Specified by:

afterPerform in class AbstractBaseCommand<WB extends WaveBean>

Parameters:

wave - the wave that triggered this command

isRunning

public boolean isRunning()

Returns:

Returns the running.

perform

protected void perform(Wave wave)

Perform the command code.

Specified by:

perform in class AbstractBaseCommand<WB extends WaveBean>

Parameters:

wave - the wave that contain data to be processed

waveConsumed

public void waveConsumed(Wave wave)

The wave has just been consumed.

Specified by:

waveConsumed in interface WaveListener

Parameters:

wave - the consumed wave

waveFailed

public void waveFailed(Wave wave)

The wave processing has failed.

Specified by:

waveFailed in interface WaveListener

Parameters:

wave - the failed wave

waveCancelled

public void waveCancelled(Wave wave)

The wave has just been cancelled.

Specified by:

waveCancelled in interface WaveListener

Parameters:

wave - the cancelled wave

waveDestroyed

public void waveDestroyed(Wave wave)

The wave has just been destroyed.

Specified by:

waveDestroyed in interface WaveListener

Parameters:

wave - the destroyed wave

waveCreated

public void waveCreated(Wave wave)

The wave has just been created.

Specified by:

waveCreated in interface WaveListener

Parameters:

wave - the created wave

waveSent

public void waveSent(Wave wave)

The wave has just been sent to the notifier.

Specified by:

waveSent in interface WaveListener

Parameters:

wave - the sent wave

waveProcessed

public void waveProcessed(Wave wave)

The wave is being processed.

Specified by:

waveProcessed in interface WaveListener

Parameters:

wave - the processed wave

addCommandClass

public void addCommandClass(Class<? extends Command> commandClass)

Add a command to the queue.

Specified by:

addCommandClass in interface MultiCommand<WB extends WaveBean>

Parameters:

commandClass - the class of the command to add