org.jrebirth.af.core.wave

Class WaveBase

java.lang.Object

org.jrebirth.af.core.wave.WaveBase

All Implemented Interfaces:

Wave, LinkMessages, MessageContainer

public class WaveBase
extends Object
implements Wave, LinkMessages

The class WaveBase. This Bean is used to move wave's data through layer. It allow to manage priorities.

Property Summary

Type	Property and Description
ObjectProperty<Wave.Status>	status Return the status property to allow binding.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jrebirth.af.api.wave.Wave

Wave.Status

Field Summary

Fields inherited from interface org.jrebirth.af.core.link.LinkMessages

ADD_BEHAVIOR, CALL_ANNOTATED_METHOD_ERROR, COMMAND_NOT_FOUND_ERROR, COMMAND_NOT_FOUND_MESSAGE, COMPONENT_INJECTION_FAILURE, COMPONENT_RELEASE_ERROR, CUSTOM_METHOD_NOT_FOUND, LISTEN_WAVE_TYPE, MODEL_NOT_FOUND_ERROR, MODEL_NOT_FOUND_MESSAGE, NO_WAVE_LISTENER, NOTIFIER_CONSUMES, NOTIFIER_HANDLES, SEND_WAVE, SERVICE_NOT_FOUND_ERROR, SERVICE_NOT_FOUND_MESSAGE, UNLISTEN_WAVE_TYPE, WAVE_BEAN_CREATION_ERROR, WAVE_DISPATCH_ERROR, WAVE_HANDLING_ERROR, WAVE_LOST, WAVE_LOST_CONTEXT, WAVE_SENDING_ERROR

Constructor Summary

Constructors

Constructor and Description
WaveBase() Default Constructor.

Method Summary

Modifier and Type	Method and Description
<T> Wave	add(WaveItem<T> waveItem, T value) Add a wave data.
Wave	addDatas(WaveData<?>... waveDatas) Add a list of wave data.
Wave	addWaveListener(WaveListener waveListener) Add a wave listener.
Class<?>	componentClass()
Wave	componentClass(Class<?> componentClass)
boolean	contains(WaveItem<?> waveItem) Check if an object exists.
boolean	containsNotNull(WaveItem<?> waveItem) Check if an object exists and if it isn't null.
Class<?>	fromClass()
Wave	fromClass(Class<?> fromClass)
<T> T	get(WaveItem<T> waveItem) Retrieve a value.
<T> WaveData<T>	getData(WaveItem<T> waveItem) Retrieve a wave data object.
boolean	hasWaveBean(Class<? extends WaveBean> waveBeanClass) Returns true if the wave holds the given WaveBean class.
int	priority()
Wave	priority(int priority)
Wave	relatedWave()
Wave	relatedWave(Wave nextWave)
void	removeWaveHandler(Object waveHandler) Release the given WaveHandler.
Wave	removeWaveListener(WaveListener waveListener) Remove a wave listener.
void	setWaveHandlers(List<? extends Object> waveHandlers) Store all Wave Handler.
Wave.Status	status()
Wave	status(Wave.Status status)
ObjectProperty<Wave.Status>	statusProperty() Return the status property to allow binding.
long	timestamp()
String	toString()
<WB extends WaveBean> WB	waveBean(Class<WB> waveBeanClass) Return the wave bean used to wrap wave properties.
Wave	waveBean(WaveBean waveBean) Link a wave bean.
List<WaveBean>	waveBeanList() Return all wave bean carried by this wave.
Wave	waveBeanList(List<WaveBean> waveBeanList) Add several WaveBean in a row.
List<WaveData<?>>	waveDatas() Return all wave items sorted by order.
WaveGroup	waveGroup()
Wave	waveGroup(WaveGroup waveGroup)
WaveType	waveType()
Wave	waveType(WaveType waveType)
String	wUID()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

status

public ObjectProperty<Wave.Status> statusProperty

Return the status property to allow binding.

Specified by:

statusProperty in interface Wave

Constructor Detail

WaveBase

WaveBase()

Default Constructor.

Method Detail

waveGroup

public WaveGroup waveGroup()

Specified by:

waveGroup in interface Wave

Returns:

Returns the waveGroup.

waveGroup

public Wave waveGroup(WaveGroup waveGroup)

Specified by:

waveGroup in interface Wave

Parameters:

waveGroup - The waveGroup to set.

Returns:

the current Wave to chain other method call

waveType

public WaveType waveType()

Specified by:

waveType in interface Wave

Returns:

Returns the waveType.

waveType

public Wave waveType(WaveType waveType)

Specified by:

waveType in interface Wave

Parameters:

waveType - The waveType to set.

Returns:

the current Wave to chain other method call

fromClass

public Class<?> fromClass()

Specified by:

fromClass in interface Wave

Returns:

Returns the fromClass.

fromClass

public Wave fromClass(Class<?> fromClass)

Specified by:

fromClass in interface Wave

Parameters:

fromClass - The fromClass to set.

Returns:

the current Wave to chain other method call

componentClass

public Class<?> componentClass()

Specified by:

componentClass in interface Wave

Returns:

Returns the class of the component that will handle this wave.

componentClass

public Wave componentClass(Class<?> componentClass)

Specified by:

componentClass in interface Wave

Parameters:

componentClass - the class of the component that will handle this wave.

Returns:

the current Wave to chain other method call

priority

public int priority()

Specified by:

priority in interface Wave

Returns:

Returns the priority.

priority

public Wave priority(int priority)

Specified by:

priority in interface Wave

Parameters:

priority - The priority to set.

Returns:

the current Wave to chain other method call

relatedWave

public Wave relatedWave()

Specified by:

relatedWave in interface Wave

Returns:

Returns the relatedWave.

relatedWave

public Wave relatedWave(Wave nextWave)

Specified by:

relatedWave in interface Wave

Parameters:

nextWave - The related Wave to set.

Returns:

the current Wave to chain other method call

waveDatas

public List<WaveData<?>> waveDatas()

Return all wave items sorted by order.

Specified by:

waveDatas in interface Wave

Returns:

Returns the the wave items.

addDatas

public Wave addDatas(WaveData<?>... waveDatas)

Add a list of wave data. Store objects and indexize them.

Specified by:

addDatas in interface Wave

Parameters:

waveDatas - the list of wave data to store

Returns:

the current Wave to chain other method call

add

public <T> Wave add(WaveItem<T> waveItem,
                    T value)

Add a wave data. Store an object and indexize it.

Specified by:

add in interface Wave

Type Parameters:

T - the type of the wave data to add

Parameters:

waveItem - the wave item used as hashkey

value - the data to store

Returns:

the current Wave to chain other method call

getData

public <T> WaveData<T> getData(WaveItem<T> waveItem)

Retrieve a wave data object.

Specified by:

getData in interface Wave

Type Parameters:

T - the type of the wave data to add

Parameters:

waveItem - the waveItem of the object to retrieve

Returns:

the waveData registered by the key

get

public <T> T get(WaveItem<T> waveItem)

Retrieve a value.

Specified by:

get in interface Wave

Type Parameters:

T - the type of the wave data to add

Parameters:

waveItem - waveItem of the object to retrieve

Returns:

the data registered by the key

contains

public boolean contains(WaveItem<?> waveItem)

Check if an object exists.

Specified by:

contains in interface Wave

Parameters:

waveItem - the waveItem of the object to check

Returns:

true if the waveData is registered

containsNotNull

public boolean containsNotNull(WaveItem<?> waveItem)

Check if an object exists and if it isn't null.

Specified by:

containsNotNull in interface Wave

Parameters:

waveItem - the waveItem of the object to check

Returns:

true if the waveData is registered and the value is not null

wUID

public String wUID()

Specified by:

wUID in interface Wave

Returns:

Returns the Wave Unique Identifier.

timestamp

public long timestamp()

Specified by:

timestamp in interface Wave

Returns:

Returns the Wave timestamp (for creation).

waveBean

public Wave waveBean(WaveBean waveBean)

Link a wave bean.

Specified by:

waveBean in interface Wave

Parameters:

waveBean - the wave bean already built to link

Returns:

the current Wave to chain other method call

waveBean

public <WB extends WaveBean> WB waveBean(Class<WB> waveBeanClass)

Return the wave bean used to wrap wave properties.

Specified by:

waveBean in interface Wave

Type Parameters:

WB - the WaveBean type used to chain methods call

Parameters:

waveBeanClass - the WaveBean subtype to create

Returns:

the wave bean, could be null

waveBeanList

public List<WaveBean> waveBeanList()

Return all wave bean carried by this wave. Don't use the returned list to add WaveBean.

Specified by:

waveBeanList in interface Wave

Returns:

the list of wave bean

waveBeanList

public Wave waveBeanList(List<WaveBean> waveBeanList)

Add several WaveBean in a row.

Specified by:

waveBeanList in interface Wave

Parameters:

waveBeanList - the list of WaveBean to add

Returns:

the current Wave to chain other method call

addWaveListener

public Wave addWaveListener(WaveListener waveListener)

Add a wave listener.

Specified by:

addWaveListener in interface Wave

Parameters:

waveListener - the wave listener that will be notified of wave status

Returns:

the current Wave to chain other method call

removeWaveListener

public Wave removeWaveListener(WaveListener waveListener)

Remove a wave listener.

Specified by:

removeWaveListener in interface Wave

Parameters:

waveListener - the wave listener to removed

Returns:

the current Wave to chain other method call

status

public Wave.Status status()

Specified by:

status in interface Wave

Returns:

Returns the Wave Status.

statusProperty

public ObjectProperty<Wave.Status> statusProperty()

Return the status property to allow binding.

Specified by:

statusProperty in interface Wave

status

public Wave status(Wave.Status status)

Specified by:

status in interface Wave

Parameters:

status - The status to set.

Returns:

the current Wave to chain other method call

toString

public String toString()

Overrides:

toString in class Object

setWaveHandlers

public void setWaveHandlers(List<? extends Object> waveHandlers)

Store all Wave Handler.

Specified by:

setWaveHandlers in interface Wave

Parameters:

waveHandlers - the list of WaveHandler

removeWaveHandler

public void removeWaveHandler(Object waveHandler)

Release the given WaveHandler.

Specified by:

removeWaveHandler in interface Wave

Parameters:

waveHandler - the waveHandler

hasWaveBean

public boolean hasWaveBean(Class<? extends WaveBean> waveBeanClass)

Returns true if the wave holds the given WaveBean class.

Specified by:

hasWaveBean in interface Wave

Parameters:

waveBeanClass - the type of the searched WaveBean

Returns:

true if the wave holds the given WaveBean type