org.jrebirth.af.core.wave

Class WaveItem<T>

java.lang.Object

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

Type Parameters:

T - the type of the object mapped by this WaveItem

public class WaveItem<T>
extends Object

The class WaveItem. Wave item is used to identify an object into a wave or a parameter.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private static int	idGenerator The generator of unique id.
private boolean	isParameter Flag that indicates if the WaveItem must be considered as a method parameter.
private Type	itemType The type of the related object registered by this wave item.
private String	name The WaveItem unique name.
private int	uid The unique identifier of the wave item.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WaveItem() Default Constructor.
protected	WaveItem(boolean isParameter) Default Constructor.
protected	WaveItem(String name) Default Constructor.
protected	WaveItem(String name, boolean isParameter) Constructor with all parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object waveItem)
Type	getItemType()
String	getName()
int	getUid()
int	hashCode()
static void	initEnum(WaveItemEnum waveItemEnum, WaveItem<?> wi) Initialize a WaveItem for a WaveItems.
boolean	isParameter()
private void	setName(String name) Set the name (optionally).
void	setParameter(boolean isParameter)
private void	setUid(int uid)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

idGenerator

private static int idGenerator

The generator of unique id.

uid

private int uid

The unique identifier of the wave item.

itemType

private final Type itemType

The type of the related object registered by this wave item.

name

private String name

The WaveItem unique name.

isParameter

private boolean isParameter

Flag that indicates if the WaveItem must be considered as a method parameter.

Constructor Detail

WaveItem

protected WaveItem()

Default Constructor. Set the name to null and the the isParameter flag to true

WaveItem

protected WaveItem(String name)

Default Constructor. Set the isParameter flag to true

Parameters:

name - the unique name of this wave item

WaveItem

protected WaveItem(boolean isParameter)

Default Constructor. Set the name to null

Parameters:

isParameter - the flag that indicates if this WaveItem must be considered by wave handlers

WaveItem

protected WaveItem(String name,
        boolean isParameter)

Constructor with all parameters.

Parameters:

name - the unique name of this wave item

isParameter - the flag that indicates if this WaveItem must be considered by wave handlers

Method Detail

getName

public String getName()

Returns:

Returns the name.

getUid

public int getUid()

Returns:

Returns the uid.

setUid

private void setUid(int uid)

Parameters:

uid - The uid to set.

getItemType

public Type getItemType()

Returns:

Returns the itemType.

equals

public boolean equals(Object waveItem)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setName

private void setName(String name)

Set the name (optionally).

Parameters:

name - the name to set

isParameter

public boolean isParameter()

Returns:

Returns the isParameter.

setParameter

public void setParameter(boolean isParameter)

Parameters:

isParameter - The isParameter to set.

toString

public String toString()

Overrides:

toString in class Object

initEnum

public static void initEnum(WaveItemEnum waveItemEnum,
            WaveItem<?> wi)

Initialize a WaveItem for a WaveItems.

Parameters:

waveItemEnum - the enumerated wave item

wi - the real waveItem