org.jrebirth.af.core.wave

Interface Wave

All Known Implementing Classes:

WaveBase

public interface Wave

The interface Wave. A Wave is a message which contain a type and a map of object.

Author:

Sébastien Bordes

Property Summary

Properties

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Wave.Status The class Status.

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	add(WaveItem<T> waveItem, T value) Add a wave data.
<T> void	addData(WaveData<T> waveData) Add a wave data.
void	addDatas(WaveData<?>[] waveDatas) Add a list of wave data.
void	addWaveListener(WaveListener waveListener) Add a wave listener.
boolean	contains(WaveItem<?> waveItem) Check if an object exists.
boolean	containsNotNull(WaveItem<?> waveItem) Check if an object exists and if it isn't null.
<T> T	get(WaveItem<T> waveItem) Retrieve a value.
<T> WaveData<T>	getData(WaveItem<T> waveItem) Retrieve a wave data object.
Class<?>	getFromClass()
int	getPriority()
Class<?>	getRelatedClass()
Wave	getRelatedWave()
Wave.Status	getStatus()
long	getTimestamp()
WaveBean	getWaveBean() Return the wave bean used to wrap wave properties.
WaveGroup	getWaveGroup()
List<WaveData<?>>	getWaveItems() Return all wave items sorted by order.
WaveType	getWaveType()
String	getWUID()
void	linkWaveBean(WaveBean waveBean) Link a wave bean.
void	removeWaveListener(WaveListener waveListener) Remove a wave listener.
void	setFromClass(Class<?> fromClass)
void	setPriority(int priority)
void	setRelatedClass(Class<?> relatedClass)
void	setRelatedWave(Wave relatedWave)
void	setStatus(Wave.Status status)
void	setWaveGroup(WaveGroup waveGroup)
void	setWaveType(WaveType waveType)
ObjectProperty<Wave.Status>	statusProperty() Return the status property to allow binding.

Property Detail

status

Return the status property to allow binding.

Returns:

the status property

Method Detail

getStatus

Wave.Status getStatus()

Returns:

Returns the Wave Status.

setStatus

void setStatus(Wave.Status status)

Parameters:

status - The status to set.

statusProperty

ObjectProperty<Wave.Status> statusProperty()

Return the status property to allow binding.

Returns:

the status property

getWUID

String getWUID()

Returns:

Returns the Wave Unique Identifier.

getTimestamp

long getTimestamp()

Returns:

Returns the Wave timestamp (for creation).

getWaveGroup

WaveGroup getWaveGroup()

Returns:

Returns the waveGroup.

setWaveGroup

void setWaveGroup(WaveGroup waveGroup)

Parameters:

waveGroup - The waveGroup to set.

getWaveType

WaveType getWaveType()

Returns:

Returns the waveType.

setWaveType

void setWaveType(WaveType waveType)

Parameters:

waveType - The waveType to set.

getFromClass

Class<?> getFromClass()

Returns:

Returns the fromClass.

setFromClass

void setFromClass(Class<?> fromClass)

Parameters:

fromClass - The fromClass to set.

getRelatedClass

Class<?> getRelatedClass()

Returns:

Returns the relatedClass.

setRelatedClass

void setRelatedClass(Class<?> relatedClass)

Parameters:

relatedClass - The relatedClass to set.

getPriority

int getPriority()

Returns:

Returns the priority.

setPriority

void setPriority(int priority)

Parameters:

priority - The priority to set.

getRelatedWave

Wave getRelatedWave()

Returns:

Returns the relatedWave.

setRelatedWave

void setRelatedWave(Wave relatedWave)

Parameters:

relatedWave - The related Wave to set.

getWaveItems

List<WaveData<?>> getWaveItems()

Return all wave items sorted by order.

Returns:

Returns the the wave items.

addData

<T> void addData(WaveData<T> waveData)

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

Type Parameters:

T - the type of the wave data to add

Parameters:

waveData - the object to store

addDatas

void addDatas(WaveData<?>[] waveDatas)

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

Parameters:

waveDatas - the list of wave data to store

add

<T> void add(WaveItem<T> waveItem,
           T value)

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

Type Parameters:

T - the type of the wave data to add

Parameters:

waveItem - the wave item used as hashkey

value - the data to store

getData

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

Retrieve a wave data object.

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

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

Retrieve a value.

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

boolean contains(WaveItem<?> waveItem)

Check if an object exists.

Parameters:

waveItem - the waveItem of the object to check

Returns:

true if the waveData is registered

containsNotNull

boolean containsNotNull(WaveItem<?> waveItem)

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

Parameters:

waveItem - the waveItem of the object to check

Returns:

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

getWaveBean

WaveBean getWaveBean()

Return the wave bean used to wrap wave properties.

Returns:

the wave bean, could be null

addWaveListener

void addWaveListener(WaveListener waveListener)

Add a wave listener.

Parameters:

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

removeWaveListener

void removeWaveListener(WaveListener waveListener)

Remove a wave listener.

Parameters:

waveListener - the wave listener to removed

linkWaveBean

void linkWaveBean(WaveBean waveBean)

Link a wave bean.

Parameters:

waveBean - the wave bean already built to link