WaveBase (Core Lib 7.7.3 API)

java.lang.Object
- org.jrebirth.af.core.wave.WaveBase

All Implemented Interfaces:

LinkMessages, MessageContainer, Wave
```
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

Properties
Type Property and Description

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

Properties
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.core.wave.Wave
  Wave.Status

Field Summary

Fields
Modifier and Type	Field and Description
`private Class<?>`	`fromClass` The from class to used for create waves.
`private static JRLogger`	`LOGGER` The class logger.
`private int`	`priority` The priority used to process wave according to a custom order.
`private Class<?>`	`relatedClass` The related class to used for create waves.
`private Wave`	`relatedWave` The related wave to the current wave, cold be a parent wave or child wave according context.
`private static String`	`SPACE_SEP` The space separator.
`private ObjectProperty<Wave.Status>`	`statusProperty` The wave status (can be bound).
`private long`	`timestamp` The Wave timestamp.
`private WaveBean`	`waveBean` The wave bean.
`private Class<? extends WaveBean>`	`waveBeanClass` The type extending WaveBean to use to embed some values.
`private List<WaveData<?>>`	`waveDataList` A sorted list that contains all data.
`private WaveGroup`	`waveGroup` The group of the wave used to dispatch the right event.
`private Map<WaveItem<?>,WaveData<?>>`	`waveItemsMap` A map used to contain all data.
`private List<WaveListener>`	`waveListeners` The list of wave Listener to warn when wave status changed.
`private WaveType`	`waveType` The type of the wave used to call the right method name of the receiver object.
`private String`	`wuid` The Wave Unique Identifier.

Constructor Summary

Constructors
Constructor and Description

WaveBase()
Default Constructor.

Constructors
Constructor and Description
`WaveBase()` Default Constructor.

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.
`private void`	`fireStatusChanged()` Fire a wave status change.
`<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.
`Class<? extends WaveBean>`	`getWaveBeanClass()`
`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 nextWave)`
`void`	`setStatus(Wave.Status status)`
`void`	`setWaveBeanClass(Class<? extends WaveBean> waveBeanClass)`
`void`	`setWaveGroup(WaveGroup waveGroup)`
`void`	`setWaveType(WaveType waveType)`
`ObjectProperty<Wave.Status>`	`statusProperty()` Return the status property to allow binding.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - status
    
    Return the status property to allow binding.
    
    Specified by:
    
    statusProperty in interface Wave
    
    Returns:
    the status property
- Field Detail
  - LOGGER
```
private static final JRLogger LOGGER
```
    The class logger.
  - SPACE_SEP
```
private static final String SPACE_SEP
```
    The space separator.
    
    See Also:
    Constant Field Values
  - wuid
```
private final String wuid
```
    The Wave Unique Identifier.
  - timestamp
```
private final long timestamp
```
    The Wave timestamp.
  - statusProperty
```
private final ObjectProperty<Wave.Status> statusProperty
```
    The wave status (can be bound).
  - waveGroup
```
private WaveGroup waveGroup
```
    The group of the wave used to dispatch the right event.
  - waveType
```
private WaveType waveType
```
    The type of the wave used to call the right method name of the receiver object.
  - fromClass
```
private Class<?> fromClass
```
    The from class to used for create waves.
  - relatedClass
```
private Class<?> relatedClass
```
    The related class to used for create waves.
  - priority
```
private int priority
```
    The priority used to process wave according to a custom order.
  - relatedWave
```
private Wave relatedWave
```
    The related wave to the current wave, cold be a parent wave or child wave according context.
  - waveItemsMap
```
private final Map<WaveItem<?>,WaveData<?>> waveItemsMap
```
    A map used to contain all data.
  - waveDataList
```
private final List<WaveData<?>> waveDataList
```
    A sorted list that contains all data.
  - waveBean
```
private WaveBean waveBean
```
    The wave bean.
  - waveBeanClass
```
private Class<? extends WaveBean> waveBeanClass
```
    The type extending WaveBean to use to embed some values.
  - waveListeners
```
private final List<WaveListener> waveListeners
```
    The list of wave Listener to warn when wave status changed.
- Constructor Detail
  - WaveBase
```
public WaveBase()
```
    Default Constructor.
- Method Detail
  - getWaveGroup
```
public WaveGroup getWaveGroup()
```
    Specified by:
    
    getWaveGroup in interface Wave
    
    Returns:
    Returns the waveGroup.
  - setWaveGroup
```
public void setWaveGroup(WaveGroup waveGroup)
```
    Specified by:
    
    setWaveGroup in interface Wave
    
    Parameters:
    waveGroup - The waveGroup to set.
  - getWaveType
```
public WaveType getWaveType()
```
    Specified by:
    
    getWaveType in interface Wave
    
    Returns:
    Returns the waveType.
  - setWaveType
```
public void setWaveType(WaveType waveType)
```
    Specified by:
    
    setWaveType in interface Wave
    
    Parameters:
    waveType - The waveType to set.
  - getFromClass
```
public Class<?> getFromClass()
```
    Specified by:
    
    getFromClass in interface Wave
    
    Returns:
    Returns the fromClass.
  - setFromClass
```
public void setFromClass(Class<?> fromClass)
```
    Specified by:
    
    setFromClass in interface Wave
    
    Parameters:
    fromClass - The fromClass to set.
  - getRelatedClass
```
public Class<?> getRelatedClass()
```
    Specified by:
    
    getRelatedClass in interface Wave
    
    Returns:
    Returns the relatedClass.
  - setRelatedClass
```
public void setRelatedClass(Class<?> relatedClass)
```
    Specified by:
    
    setRelatedClass in interface Wave
    
    Parameters:
    relatedClass - The relatedClass to set.
  - getPriority
```
public int getPriority()
```
    Specified by:
    
    getPriority in interface Wave
    
    Returns:
    Returns the priority.
  - setPriority
```
public void setPriority(int priority)
```
    Specified by:
    
    setPriority in interface Wave
    
    Parameters:
    priority - The priority to set.
  - getRelatedWave
```
public Wave getRelatedWave()
```
    Specified by:
    
    getRelatedWave in interface Wave
    
    Returns:
    Returns the relatedWave.
  - setRelatedWave
```
public void setRelatedWave(Wave nextWave)
```
    Specified by:
    
    setRelatedWave in interface Wave
    
    Parameters:
    nextWave - The related Wave to set.
  - getWaveItems
```
public List<WaveData<?>> getWaveItems()
```
    Return all wave items sorted by order.
    
    Specified by:
    
    getWaveItems in interface Wave
    
    Returns:
    Returns the the wave items.
  - addData
```
public <T> void addData(WaveData<T> waveData)
```
    Add a wave data. Store an object and indexize it.
    
    Specified by:
    
    addData in interface Wave
    
    Type Parameters:
    T - the type of the wave data to add
    Parameters:
    waveData - the object to store
  - addDatas
```
public void 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
  - add
```
public <T> void 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
  - 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
  - getWUID
```
public String getWUID()
```
    Specified by:
    
    getWUID in interface Wave
    
    Returns:
    Returns the Wave Unique Identifier.
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Wave
    
    Returns:
    Returns the Wave timestamp (for creation).
  - getWaveBean
```
public WaveBean getWaveBean()
```
    Return the wave bean used to wrap wave properties.
    
    Specified by:
    
    getWaveBean in interface Wave
    
    Returns:
    the wave bean, could be null
  - getWaveBeanClass
```
public Class<? extends WaveBean> getWaveBeanClass()
```
    Returns:
    Returns the waveBeanClass.
  - setWaveBeanClass
```
public void setWaveBeanClass(Class<? extends WaveBean> waveBeanClass)
```
    Parameters:
    waveBeanClass - The waveBeanClass to set.
  - addWaveListener
```
public void 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
  - removeWaveListener
```
public void removeWaveListener(WaveListener waveListener)
```
    Remove a wave listener.
    
    Specified by:
    
    removeWaveListener in interface Wave
    
    Parameters:
    waveListener - the wave listener to removed
  - getStatus
```
public Wave.Status getStatus()
```
    Specified by:
    
    getStatus 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
    
    Returns:
    the status property
  - setStatus
```
public void setStatus(Wave.Status status)
```
    Specified by:
    
    setStatus in interface Wave
    
    Parameters:
    status - The status to set.
  - fireStatusChanged
```
private void fireStatusChanged()
```
    Fire a wave status change.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - linkWaveBean
```
public void linkWaveBean(WaveBean waveBean)
```
    Link a wave bean.
    
    Specified by:
    
    linkWaveBean in interface Wave
    
    Parameters:
    waveBean - the wave bean already built to link

Class WaveBase

Property Summary

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

status

Field Detail

LOGGER

SPACE_SEP

wuid

timestamp

statusProperty

waveGroup

waveType

fromClass

relatedClass

priority

relatedWave

waveItemsMap

waveDataList

waveBean

waveBeanClass

waveListeners

Constructor Detail

WaveBase

Method Detail

getWaveGroup

setWaveGroup

getWaveType

setWaveType

getFromClass

setFromClass

getRelatedClass

setRelatedClass

getPriority

setPriority

getRelatedWave

setRelatedWave

getWaveItems

addData

addDatas

add

getData

get

contains

containsNotNull

getWUID

getTimestamp

getWaveBean

getWaveBeanClass

setWaveBeanClass

addWaveListener

removeWaveListener

getStatus

statusProperty

setStatus

fireStatusChanged

toString

linkWaveBean