org.jrebirth.af.core.facade

Interface WaveReady<R extends WaveReady<R>>

Type Parameters:

R - A type that implements FacadeReady

All Superinterfaces:

CommandReady, FacadeReady<R>, ModelReady, ServiceReady

All Known Subinterfaces:

Command, CommandBean<WB>, Model, MultiCommand<WB>, Service

All Known Implementing Classes:

AbstractBaseCommand, AbstractBaseModel, AbstractFXMLModel, AbstractFXMLObjectModel, AbstractModel, AbstractMultiCommand, AbstractObjectModel, AbstractService, AbstractSimpleModel, AbstractSimpleObjectModel, AbstractSingleCommand, AbstractWaveReady, AttachModelCommand, ChainServiceCommand, ChainWaveCommand, DefaultBeanCommand, DefaultCommand, DefaultFXMLModel, DefaultFXMLObjectModel, DefaultModel, DefaultMultiBeanCommand, DefaultMultiCommand, DefaultObjectModel, DefaultPoolBeanCommand, DefaultPoolCommand, DefaultService, DefaultSimpleModel, DefaultSimpleObjectModel, DefaultUIBeanCommand, DefaultUICommand, DetachModelCommand, FadeTransitionCommand, PrepareModelCommand, ShowErrorDialog, ShowFadingModelCommand, ShowModelCommand, StageCommand, StageService, StyleSheetTrackerService, SwitchFullScreenCommand, TaskTrackerService

public interface WaveReady<R extends WaveReady<R>>
extends FacadeReady<R>

The interface WaveReady. Define the contract used to manage waves.

Author:

Sébastien Bordes

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	listen(WaveChecker waveChecker, Method method, WaveType... waveType) Begin to listen the type of wave for the current component.
void	listen(WaveChecker waveChecker, WaveType... waveType) Begin to listen the type of wave for the current component.
void	listen(WaveType... waveType) Begin to listen the type of wave for the current component.
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	sendWave(Wave wave) Send a wave to the notifier.
Wave	sendWave(WaveType waveType, WaveData<?>... waveData) Send a wave to the notifier.
void	unlisten(WaveType... waveTypes) Stop to listen the type of wave for the current component.

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

Method Detail

listen

void listen(WaveType... waveType)

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

Parameters:

waveType - the type(s) to listen

listen

void listen(WaveChecker waveChecker,
          WaveType... waveType)

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

Parameters:

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

waveType - the type(s) to listen

listen

void listen(WaveChecker waveChecker,
          Method method,
          WaveType... waveType)

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

Parameters:

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

method - the annotated method concerned

waveType - the type(s) to listen

registerCallback

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

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

registerCallback

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

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

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

Parameters:

callType - the wave type mapped to this service.

responseType - the wave type of the wave emitted in return

unlisten

void unlisten(WaveType... waveTypes)

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

Parameters:

waveTypes - the type(s) to stop to listen

sendWave

void sendWave(Wave wave)

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

Parameters:

wave - the wave to send

sendWave

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

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

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

getReturnWaveType

WaveType getReturnWaveType(WaveType waveType)

Return the return wave type.

Parameters:

waveType - the source wave type

Returns:

Returns the waveType for return wave.

getReturnCommand

Class<? extends Command> getReturnCommand(WaveType waveType)

Return the return Command to call for given wave type.

Parameters:

waveType - the source wave type

Returns:

Returns the Command class to call (or null.