org.jrebirth.af.core.wave

Class WaveData<T>

java.lang.Object

org.jrebirth.af.core.wave.WaveData<T>

Type Parameters:

T - the type of the data hold

All Implemented Interfaces:

Comparable<WaveData<?>>

public final class WaveData<T>
extends Object
implements Comparable<WaveData<?>>

The class WaveData. Used to contain a value and its unique name.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private int	order The field used for sorting.
private T	value The value data.
private WaveItem<T>	waveItem The key property, must be set with an enumeration that implements WaveItem.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WaveData(WaveItem<T> waveItem, T value) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> WaveData<T>	build(WaveItem<T> waveItem, T value) Build a wave data.
int	compareTo(WaveData<?> waveData)
boolean	equals(Object obj)
WaveItem<T>	getKey()
int	getOrder()
T	getValue()
int	hashCode()
void	setKey(WaveItem<T> waveItem)
void	setOrder(int order)
void	setValue(T value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

waveItem

private WaveItem<T> waveItem

The key property, must be set with an enumeration that implements WaveItem.

value

private T value

The value data.

order

private int order

The field used for sorting.

Constructor Detail

WaveData

private WaveData(WaveItem<T> waveItem,
        T value)

Default Constructor.

Parameters:

waveItem - the enumeration used as key property

value - the data

Method Detail

build

public static <T> WaveData<T> build(WaveItem<T> waveItem,
                    T value)

Build a wave data.

Type Parameters:

T - the type of the object wrapped by this WaveData

Parameters:

waveItem - the wave item used as the key into the wave

value - the data hold by he wave data wrapper

Returns:

a new fresh wave Data object

getKey

public WaveItem<T> getKey()

Returns:

Returns the waveItem.

setKey

public void setKey(WaveItem<T> waveItem)

Parameters:

waveItem - the waveItem to set

getValue

public T getValue()

Returns:

Returns the value.

setValue

public void setValue(T value)

Parameters:

value - the value to set

getOrder

public int getOrder()

Returns:

Returns the order.

setOrder

public void setOrder(int order)

Parameters:

order - The order to set.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(WaveData<?> waveData)

Specified by:

compareTo in interface Comparable<WaveData<?>>