org.jrebirth.af.core.link

Class AbstractWaveReady<R extends WaveReady<R>>

java.lang.Object

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

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

Type Parameters:

R - the class type of the subclass

All Implemented Interfaces:

FacadeReady<R>, WaveReady<R>, CommandReady, LinkMessages, ModelReady, ServiceReady, MessageContainer

Direct Known Subclasses:

AbstractBaseCommand, AbstractBaseModel, AbstractService

@SkipAnnotation(value=false)
public abstract class AbstractWaveReady<R extends WaveReady<R>>
extends AbstractReady<R>
implements WaveReady<R>, LinkMessages

The class AbstractWaveReady. This is the base class for all of each of JRebirth pattern subclasses.
It allow to send waves. All things related to wave management must be execute into the JRebirth Thread

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,List<Method>>	lifecycleMethod A map that store all annotated methods to call sorted by lifecycle phase.
private static JRLogger	LOGGER The class logger.
static String	PROCESS_WAVE_METHOD_NAME The default fallback wave handle method.
private Map<WaveType,Class<? extends Command>>	returnCommandClass The return command class map.
private Map<WaveType,WaveType>	returnWaveTypeMap The return wave type map.

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
AbstractWaveReady()

Method Summary

Methods

Modifier and Type	Method and Description
Wave	attachUi(Class<? extends Model> modelClass, WaveData<?>... data) Send a wave used to display an UI model.
private void	callAnnotatedMethod(Class<? extends Annotation> annotationClass) Call annotated methods corresponding at given lifecycle annotation.
Wave	callCommand(Class<? extends Command> commandClass, WaveData<?>... data) Send a wave used to call a command.
<WB extends WaveBean> Wave	callCommand(Class<? extends CommandBean<WB>> commandClass, WB waveBean) Send a wave used to call a command.
private Wave	createWave(WaveGroup waveGroup, WaveType waveType, Class<?> relatedClass, WaveBean waveBean) Build a wave object with its dedicated WaveBean.
private Wave	createWave(WaveGroup waveGroup, WaveType waveType, Class<?> relatedClass, WaveData<?>... waveData) Build a wave object.
private Notifier	getNotifier() Short cut method used to retrieve the notifier.
Class<? extends Command>	getReturnCommand(WaveType waveType) Return the return Command to call for given wave type.
WaveType	getReturnWaveType(WaveType waveType) Return the return wave type.
private WaveReady<?>	getWaveReady() Private method used to grab the right WaveType
private String	getWaveTypesString(WaveType[] waveTypes) Return the human-readable list of Wave Type.
void	listen(WaveChecker waveChecker, Method method, WaveType... waveTypes) Begin to listen the type of wave for the current component.
void	listen(WaveChecker waveChecker, WaveType... waveTypes) Begin to listen the type of wave for the current component.
void	listen(WaveType... waveTypes) Begin to listen the type of wave for the current component.
protected abstract void	processWave(Wave wave) Process the wave.
protected abstract void	ready() The component is now ready to do custom initialization tasks.
void	registerCallback(WaveChecker waveChecker, WaveType callType, WaveType responseType, Class<? extends Command> returnCommandClass) Register a wave call back contract.
void	registerCallback(WaveType callType, WaveType responseType) Register a wave call back contract.
void	registerCallback(WaveType callType, WaveType responseType, Class<? extends Command> returnCommandClass) Register a wave call back contract.
void	release() Release the component by deleting this key used by the WeakHashMap.
Wave	returnData(Class<? extends Service> serviceClass, WaveType waveType, WaveData<?>... data) Send a wave used to return data from a service.
void	sendWave(Wave wave) Send a wave to the notifier.
Wave	sendWave(WaveType waveType, WaveData<?>... waveData) Send a wave to the notifier.
private Wave	sendWaveIntoJit(Wave wave) Send the given wave using the JRebirth Thread.
void	setup() Launch the initialization of the component.
void	unlisten(WaveType... waveTypes) Stop to listen the type of wave for the current component.

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getKey, getLocalFacade, setKey, setLocalFacade

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

getModel

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

getService

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

getCommand

Field Detail

PROCESS_WAVE_METHOD_NAME

public static final String PROCESS_WAVE_METHOD_NAME

The default fallback wave handle method.

See Also:

Constant Field Values

LOGGER

private static final JRLogger LOGGER

The class logger.

returnWaveTypeMap

private final Map<WaveType,WaveType> returnWaveTypeMap

The return wave type map.

returnCommandClass

private final Map<WaveType,Class<? extends Command>> returnCommandClass

The return command class map.

lifecycleMethod

private Map<String,List<Method>> lifecycleMethod

A map that store all annotated methods to call sorted by lifecycle phase.

Constructor Detail

AbstractWaveReady

public AbstractWaveReady()

Method Detail

getNotifier

private Notifier getNotifier()

Short cut method used to retrieve the notifier.

Returns:

the notifier retrieved from global facade

listen

public final void listen(WaveType... waveTypes)

Begin to listen the type of wave for the current component. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true

Specified by:

listen in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveTypes - the type(s) to listen

listen

public final void listen(WaveChecker waveChecker,
          WaveType... waveTypes)

Begin to listen the type of wave for the current component. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true The wave checker is used to filter the wave if the checker returns false

Specified by:

listen in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveChecker - the wave checker used to forward the wave only if the checker return true

waveTypes - the type(s) to listen

getWaveTypesString

private String getWaveTypesString(WaveType[] waveTypes)

Return the human-readable list of Wave Type.

Parameters:

waveTypes - the list of wave type

Returns:

the string list of Wave Type

listen

public final void listen(WaveChecker waveChecker,
          Method method,
          WaveType... waveTypes)

Begin to listen the type of wave for the current component. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true The wave checker is used to filter the wave if the checker returns false

Specified by:

listen in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveChecker - the wave checker used to forward the wave only if the checker return true

method - the annotated method concerned

waveTypes - the type(s) to listen

registerCallback

public final void registerCallback(WaveType callType,
                    WaveType responseType)

Register a wave call back contract. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true

Specified by:

registerCallback in interface WaveReady<R extends WaveReady<R>>

Parameters:

callType - the wave type mapped to this service.

responseType - the wave type of the wave emitted in return

registerCallback

public final void registerCallback(WaveType callType,
                    WaveType responseType,
                    Class<? extends Command> returnCommandClass)

Register a wave call back contract. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true

Specified by:

registerCallback in interface WaveReady<R extends WaveReady<R>>

Parameters:

callType - the wave type mapped to this service.

responseType - the wave type of the wave emitted in return

returnCommandClass - the command class to call to process the service result

registerCallback

public final void registerCallback(WaveChecker waveChecker,
                    WaveType callType,
                    WaveType responseType,
                    Class<? extends Command> returnCommandClass)

Register a wave call back contract. Wave Contract will be checked if org.jrebirth.af.core.resource.provided.JRebirthParameters.DEVELOPER_MODE parameter is true

Specified by:

registerCallback in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveChecker - the wave checker used to forward the wave only if the checker return true

callType - the wave type mapped to this service.

responseType - the wave type of the wave emitted in return

returnCommandClass - the command class to call to process the service result

getReturnWaveType

public final WaveType getReturnWaveType(WaveType waveType)

Return the return wave type.

Specified by:

getReturnWaveType in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveType - the source wave type

Returns:

Returns the waveType for return wave.

getReturnCommand

public final Class<? extends Command> getReturnCommand(WaveType waveType)

Return the return Command to call for given wave type.

Specified by:

getReturnCommand in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveType - the source wave type

Returns:

Returns the Command class to call (or null.

unlisten

public final void unlisten(WaveType... waveTypes)

Stop to listen the type of wave for the current component.

Specified by:

unlisten in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveTypes - the type(s) to stop to listen

sendWave

public final void sendWave(Wave wave)

Send a wave to the notifier. The wave will automatically be sent from JRebirthThread.

Specified by:

sendWave in interface WaveReady<R extends WaveReady<R>>

Parameters:

wave - the wave to send

sendWave

public final Wave sendWave(WaveType waveType,
            WaveData<?>... waveData)

Send a wave to the notifier. The wave will automatically be sent from JRebirthThread.

Specified by:

sendWave in interface WaveReady<R extends WaveReady<R>>

Parameters:

waveType - the type of wave to send

waveData - the data (key-value

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

callCommand

public final <WB extends WaveBean> Wave callCommand(Class<? extends CommandBean<WB>> commandClass,
                                     WB waveBean)

Send a wave used to call a command. The command will be called from JRebirthThread and could execute itself from another thread.

Specified by:

callCommand in interface CommandReady

Type Parameters:

WB - the type of the wave bean to used

Parameters:

commandClass - the command class to call

waveBean - the WaveBean that holds all required wave data

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

callCommand

public final Wave callCommand(Class<? extends Command> commandClass,
               WaveData<?>... data)

Send a wave used to call a command. The command will be called from JRebirthThread and could execute itself from another thread.

Specified by:

callCommand in interface CommandReady

Parameters:

commandClass - the command class to call

data - the data to transport

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

returnData

public final Wave returnData(Class<? extends Service> serviceClass,
              WaveType waveType,
              WaveData<?>... data)

Send a wave used to return data from a service. The service will be called from JRebirthThread and could execute itself from another thread.

Specified by:

returnData in interface ServiceReady

Parameters:

serviceClass - the service called

waveType - the type of the wave

data - the data to transport

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

attachUi

public final Wave attachUi(Class<? extends Model> modelClass,
            WaveData<?>... data)

Send a wave used to display an UI model. The command will be called from JRebirthThread but will execute itself from the JavaFX Application thread.

Specified by:

attachUi in interface ModelReady

Parameters:

modelClass - the model class to display

data - the data to transport

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

sendWaveIntoJit

private Wave sendWaveIntoJit(Wave wave)

Send the given wave using the JRebirth Thread.

Parameters:

wave - the wave to send

Returns:

the wave sent to JIT (with Sent status)

createWave

private Wave createWave(WaveGroup waveGroup,
              WaveType waveType,
              Class<?> relatedClass,
              WaveData<?>... waveData)

Build a wave object.

Parameters:

waveGroup - the group of the wave

waveType - the type of the wave

relatedClass - the related class if any

waveData - wave data to use

Returns:

the wave built

createWave

private Wave createWave(WaveGroup waveGroup,
              WaveType waveType,
              Class<?> relatedClass,
              WaveBean waveBean)

Build a wave object with its dedicated WaveBean.

Parameters:

waveGroup - the group of the wave

waveType - the type of the wave

relatedClass - the related class if any

waveBean - the wave bean that holds all required wave data

Returns:

the wave built

processWave

protected abstract void processWave(Wave wave)

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

Parameters:

wave - the wave received

setup

public void setup()
           throws CoreException

Launch the initialization of the component. This method is always called into JIT

Specified by:

setup in interface FacadeReady<R extends WaveReady<R>>

Throws:

CoreException - if the initialization fails

release

public void release()

Release the component by deleting this key used by the WeakHashMap.

Specified by:

release in interface FacadeReady<R extends WaveReady<R>>

getWaveReady

private WaveReady<?> getWaveReady()

Private method used to grab the right WaveType java type.

Returns:

the this instance with the right generic type

callAnnotatedMethod

private void callAnnotatedMethod(Class<? extends Annotation> annotationClass)

Call annotated methods corresponding at given lifecycle annotation.

Parameters:

annotationClass - the annotation related to the lifecycle

ready

protected abstract void ready()
                       throws CoreException

The component is now ready to do custom initialization tasks.

Throws:

CoreException - if an error occurred