org.jrebirth.af.core.command

Class AbstractBaseCommand<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>

Type Parameters:

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMultiCommand, AbstractSingleCommand

public abstract class AbstractBaseCommand<WB extends WaveBean>
extends AbstractWaveReady<Command>
implements CommandBean<WB>

The class AbstractBaseCommand. Base implementation of the command. Allow to run the command in different thread according to the runInto field value.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOGGER The class logger.
private RunType	runIntoThread The field that indicates how this command must be launched.
private RunnablePriority	runnablePriority The field that indicates the threading priority.

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
AbstractBaseCommand() Default constructor.
AbstractBaseCommand(RunType runType, RunnablePriority priority) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	afterPerform(Wave wave) Actions to perform after the command into the executor thread.
protected abstract void	beforePerform(Wave wave) Actions to perform before the command into the executor thread.
protected void	finalize()
protected void	fireConsumed(Wave wave) Fire a consumed event for command listeners.
protected void	fireFailed(Wave wave) Fire a failed event for command listeners.
protected RunType	getRunInto()
protected RunnablePriority	getRunnablePriority()
WB	getWaveBean(Wave wave) Get the wave bean and cast it.
(package private) void	innerRun(Wave wave) Run the inner task.
protected abstract void	perform(Wave wave) Perform the command code.
protected void	processWave(Wave wave) Process the wave.
Wave	run() Run the command.
Wave	run(Wave wave) Run the command.

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

attachUi, callCommand, callCommand, getReturnCommand, getReturnWaveType, listen, listen, listen, ready, 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.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

LOGGER

private static final org.slf4j.Logger LOGGER

The class logger.

runIntoThread

private final RunType runIntoThread

The field that indicates how this command must be launched.

runnablePriority

private RunnablePriority runnablePriority

The field that indicates the threading priority.

Constructor Detail

AbstractBaseCommand

public AbstractBaseCommand()

Default constructor. The RunIntoThread property is defined according to (ordered by priority):

1. RunInto annotation
2. JRebirth Internal Thread

AbstractBaseCommand

public AbstractBaseCommand(RunType runType,
                   RunnablePriority priority)

Default constructor. The RunIntoThread property is defined according to (ordered by priority):

1. RunInto annotation
2. Provided RunType argument
3. JRebirth Internal Thread

Parameters:

runType - the way to launch this command

priority - the runnable priority

Method Detail

perform

protected abstract void perform(Wave wave)
                         throws CommandException

Perform the command code.

Parameters:

wave - the wave that contain data to be processed

Throws:

CommandException - if an error occurred while processing the command

processWave

protected void processWave(Wave wave)

Process the wave. Typically by using a switch on the waveType.

Specified by:

processWave in class AbstractWaveReady<Command>

Parameters:

wave - the wave received

run

public final Wave run()

Run the command.

Specified by:

run in interface Command

Returns:

the wave created to launch the command, it allows to track its internal process

run

public final Wave run(Wave wave)

Run the command.

Specified by:

run in interface Command

Parameters:

wave - the wave that have triggered this command

Returns:

the wave created to launch the command, it allows to track its internal process

innerRun

final void innerRun(Wave wave)
             throws CommandException

Run the inner task.

Parameters:

wave - the wave that have triggered this command

Throws:

CommandException - if an error occurred

beforePerform

protected abstract void beforePerform(Wave wave)

Actions to perform before the command into the executor thread.

Parameters:

wave - the wave that triggered this command

afterPerform

protected abstract void afterPerform(Wave wave)

Actions to perform after the command into the executor thread.

Parameters:

wave - the wave that triggered this command

getRunInto

protected final RunType getRunInto()

Returns:

Returns the runInto.

getRunnablePriority

protected final RunnablePriority getRunnablePriority()

Returns:

Returns the runInto.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getWaveBean

public WB getWaveBean(Wave wave)

Get the wave bean and cast it.

Specified by:

getWaveBean in interface Command

Specified by:

getWaveBean in interface CommandBean<WB extends WaveBean>

Parameters:

wave - the wave that hold the bean

Returns:

the casted wave bean

fireConsumed

protected void fireConsumed(Wave wave)

Fire a consumed event for command listeners. And consume the wave that trigger this command

Parameters:

wave - forward the wave that has been performed

fireFailed

protected void fireFailed(Wave wave)

Fire a failed event for command listeners. And mark as failed the wave that trigger this command

Parameters:

wave - forward the wave that has been performed