Wave (JRebirth Application Framework 8.5.0 API)

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

All Methods Instance Methods Abstract Methods
Type Property and Description

ObjectProperty<Wave.Status> status
Return the status property to allow binding.

All Methods Instance Methods Abstract Methods
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 enumeration Status.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Wave.Status` The enumeration Status.

Method Summary

All Methods Instance Methods Abstract Methods
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 relatedWave)`
`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()`
`<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()`

- Property Detail
  - status
```
ObjectProperty<Wave.Status> statusProperty
```
    Return the status property to allow binding.
- Method Detail
  - status
```
Wave.Status status()
```
    Returns:
    
    Returns the Wave Status.
  - status
```
Wave status(Wave.Status status)
```
    Parameters:
    
    status - The status to set.
    
    Returns:
    
    the current Wave to chain other method call
  - statusProperty
```
ObjectProperty<Wave.Status> statusProperty()
```
    Return the status property to allow binding.
  - wUID
```
String wUID()
```
    Returns:
    
    Returns the Wave Unique Identifier.
  - timestamp
```
long timestamp()
```
    Returns:
    
    Returns the Wave timestamp (for creation).
  - waveGroup
```
WaveGroup waveGroup()
```
    Returns:
    
    Returns the waveGroup.
  - waveGroup
```
Wave waveGroup(WaveGroup waveGroup)
```
    Parameters:
    
    waveGroup - The waveGroup to set.
    
    Returns:
    
    the current Wave to chain other method call
  - waveType
```
WaveType waveType()
```
    Returns:
    
    Returns the waveType.
  - waveType
```
Wave waveType(WaveType waveType)
```
    Parameters:
    
    waveType - The waveType to set.
    
    Returns:
    
    the current Wave to chain other method call
  - fromClass
```
Class<?> fromClass()
```
    Returns:
    
    Returns the fromClass.
  - fromClass
```
Wave fromClass(Class<?> fromClass)
```
    Parameters:
    
    fromClass - The fromClass to set.
    
    Returns:
    
    the current Wave to chain other method call
  - componentClass
```
Class<?> componentClass()
```
    Returns:
    
    Returns the class of the component that will handle this wave.
  - componentClass
```
Wave componentClass(Class<?> componentClass)
```
    Parameters:
    
    componentClass - the class of the component that will handle this wave.
    
    Returns:
    
    the current Wave to chain other method call
  - priority
```
int priority()
```
    Returns:
    
    Returns the priority.
  - priority
```
Wave priority(int priority)
```
    Parameters:
    
    priority - The priority to set.
    
    Returns:
    
    the current Wave to chain other method call
  - relatedWave
```
Wave relatedWave()
```
    Returns:
    
    Returns the relatedWave.
  - relatedWave
```
Wave relatedWave(Wave relatedWave)
```
    Parameters:
    
    relatedWave - The related Wave to set.
    
    Returns:
    
    the current Wave to chain other method call
  - waveDatas
```
List<WaveData<?>> waveDatas()
```
    Return all wave items sorted by order.
    
    Returns:
    
    Returns the the wave items.
  - add
```
<T> Wave 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
    
    Returns:
    
    the current Wave to chain other method call
  - 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
  - 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
  - addDatas
```
Wave addDatas(WaveData<?>... waveDatas)
```
    Add a list of wave data. Store objects and indexize them.
    
    Parameters:
    
    waveDatas - the list of wave data to store
    
    Returns:
    
    the current Wave to chain other method call
  - 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
  - waveBean
```
<WB extends WaveBean> WB waveBean(Class<WB> waveBeanClass)
```
    Return the wave bean used to wrap wave properties.
    
    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
  - waveBean
```
Wave waveBean(WaveBean waveBean)
```
    Link a wave bean.
    
    Parameters:
    
    waveBean - the wave bean already built to link
    
    Returns:
    
    the current Wave to chain other method call
  - waveBeanList
```
List<WaveBean> waveBeanList()
```
    Return all wave bean carried by this wave.
    
    Returns:
    
    the list of wave bean
  - waveBeanList
```
Wave waveBeanList(List<WaveBean> waveBeanList)
```
    Add several WaveBean in a row.
    
    Parameters:
    
    waveBeanList - the list of WaveBean to add
    
    Returns:
    
    the current Wave to chain other method call
  - addWaveListener
```
Wave addWaveListener(WaveListener waveListener)
```
    Add a wave listener.
    
    Parameters:
    
    waveListener - the wave listener that will be notified of wave status
    
    Returns:
    
    the current Wave to chain other method call
  - removeWaveListener
```
Wave removeWaveListener(WaveListener waveListener)
```
    Remove a wave listener.
    
    Parameters:
    
    waveListener - the wave listener to removed
    
    Returns:
    
    the current Wave to chain other method call
  - setWaveHandlers
```
void setWaveHandlers(List<? extends Object> waveHandlers)
```
    Store all Wave Handler.
    
    Parameters:
    
    waveHandlers - the list of WaveHandler
  - removeWaveHandler
```
void removeWaveHandler(Object waveHandler)
```
    Release the given WaveHandler.
    
    Parameters:
    
    waveHandler - the waveHandler
  - hasWaveBean
```
boolean hasWaveBean(Class<? extends WaveBean> waveBeanClass)
```
    Returns true if the wave holds the given WaveBean class.
    
    Parameters:
    
    waveBeanClass - the type of the searched WaveBean
    
    Returns:
    
    true if the wave holds the given WaveBean type

Interface Wave

Property Summary

Nested Class Summary

Method Summary

Property Detail

status

Method Detail

status

status

statusProperty

wUID

timestamp

waveGroup

waveGroup

waveType

waveType

fromClass

fromClass

componentClass

componentClass

priority

priority

relatedWave

relatedWave

waveDatas

add

get

getData

addDatas

contains

containsNotNull

waveBean

waveBean

waveBeanList

waveBeanList

addWaveListener

removeWaveListener

setWaveHandlers

removeWaveHandler

hasWaveBean