org.jrebirth.af.core.command

Class AbstractSingleCommand<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.AbstractSingleCommand<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:

DefaultBeanCommand, DefaultPoolBeanCommand, DefaultUIBeanCommand, FadeTransitionCommand

public abstract class AbstractSingleCommand<WB extends WaveBean>
extends AbstractBaseCommand<WB>

The class AbstractSingleCommand.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicBoolean	running The command is running.

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

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	isRunning()
void	ready() The component is now ready to do custom initialization tasks.

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

finalize, fireConsumed, fireFailed, getRunInto, getRunnablePriority, getWaveBean, innerRun, perform, 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.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

running

private final AtomicBoolean running

The command is running.

Constructor Detail

AbstractSingleCommand

public AbstractSingleCommand()

Default constructor.

AbstractSingleCommand

public AbstractSingleCommand(RunType runInto)

Default constructor.

Parameters:

runInto - the way to launch this command

AbstractSingleCommand

public AbstractSingleCommand(RunType runInto,
                     RunnablePriority priority)

Default constructor.

Parameters:

runInto - the way to launch this command

priority - the runnable priority

Method Detail

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.

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.