org.jrebirth.af.api.link

Interface Notifier

public interface Notifier

The interface Notifier. Use to propagate waves through application layers.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
void	listen(Component<?> linkedObject, WaveChecker waveChecker, Method method, WaveType... waveTypes) Start to listen a defined type of wave.
void	sendWave(Wave wave) Send wave to all facade.
void	unlisten(Component<?> linkedObject, WaveType... waveType) Stop to listen a defined type of wave.
void	unlistenAll(Component<?> linkedObject) Stop to listen all waveType listened by the component.

Method Detail

sendWave

void sendWave(Wave wave)
       throws JRebirthThreadException

Send wave to all facade. MUST BE CALLED into the JRebirthThread.

Parameters:

wave - the object that information data

Throws:

JRebirthThreadException - if called outside the JRebirthThread

listen

void listen(Component<?> linkedObject,
            WaveChecker waveChecker,
            Method method,
            WaveType... waveTypes)
     throws JRebirthThreadException

Start to listen a defined type of wave. The WaveChecker allow to route wave only to component that are concerned. MUST BE CALLED into the JRebirthThread.

Parameters:

linkedObject - an object that can process the content of a wave

waveChecker - the wave checker to filter unwanted wave to be processed by other components

method - the default method to call

waveTypes - the type(s) of wave that interests the object (one or many)

Throws:

JRebirthThreadException - if called outside the JRebirthThread

unlisten

void unlisten(Component<?> linkedObject,
              WaveType... waveType)
       throws JRebirthThreadException

Stop to listen a defined type of wave. MUST BE CALLED into the JRebirthThread.

Parameters:

linkedObject - an object that can process the content of a wave

waveType - the type of wave that doesn't interest the object anymore (one or many)

Throws:

JRebirthThreadException - if called outside the JRebirthThread

unlistenAll

void unlistenAll(Component<?> linkedObject)
          throws JRebirthThreadException

Stop to listen all waveType listened by the component. MUST BE CALLED into the JRebirthThread.

Parameters:

linkedObject - an object that can process the content of a wave

Throws:

JRebirthThreadException - if called outside the JRebirthThread