org.jrebirth.af.core.wave

Class WaveTypeBase

java.lang.Object

org.jrebirth.af.core.wave.WaveTypeBase

All Implemented Interfaces:

WaveType

public final class WaveTypeBase
extends Object
implements WaveType

The class WaveTypeBase.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private String	action The action to performed, basically the name of the method to call.
private static int	idGenerator The generator of unique id.
private WaveType	returnWaveType The wave type of the wave returned after processing.
private int	uid The unique identifier of the wave type.
private List<WaveItem<?>>	waveItemList Define arguments types to use.
private static Map<String,WaveType>	waveTypeMap Map that store WaveType used according to their unique identifier.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WaveTypeBase(String action, WaveItem<?>... waveItems) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static WaveTypeBase	build(String action, WaveItem<?>... waveItems) Build a wave type.
static WaveTypeBase	build(String action, WaveType returnWaveType, WaveItem<?>... waveItems) Build a wave type.
boolean	equals(Object waveType)
String	getAction() Gets the action.
String	getItems() Return the required method parameter list to handle this WaveType.
WaveType	getReturnWaveType() Gets the return wave type.
int	getUid() Gets the uid.
List<WaveItem<?>>	getWaveItemList() Gets the wave item list.
static WaveType	getWaveType(String action) Retrieve a WaveType according to its unique action name.
int	hashCode()
void	setReturnWaveType(WaveType returnWaveType) Sets the return wave type.
void	setUid(int uid) Sets the 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.

waveTypeMap

private static Map<String,WaveType> waveTypeMap

Map that store WaveType used according to their unique identifier.

uid

private int uid

The unique identifier of the wave type.

action

private final String action

The action to performed, basically the name of the method to call.

returnWaveType

private WaveType returnWaveType

The wave type of the wave returned after processing.

waveItemList

private final List<WaveItem<?>> waveItemList

Define arguments types to use.

Constructor Detail

WaveTypeBase

private WaveTypeBase(String action,
            WaveItem<?>... waveItems)

Default constructor.

Parameters:

action - The action to perform, "DO_" (by default see JRebirthParameters.WAVE_HANDLER_PREFIX) keyword will be prepended to the action name to generate the handler method

waveItems - the list of #WaveItemWaveItem required by this wave

Method Detail

build

public static WaveTypeBase build(String action,
                 WaveItem<?>... waveItems)

Build a wave type.

Parameters:

action - The action to perform, "DO_" keyword (by default see JRebirthParameters.WAVE_HANDLER_PREFIX) will be prepended to the action name to generate the handler method

waveItems - the list of WaveItem required by this wave

Returns:

a new fresh wave type object

getWaveType

public static WaveType getWaveType(String action)

Retrieve a WaveType according to its unique action name. Be careful it could return null if the WaveType has not been initialized yet.

Parameters:

action - the unique action name used to register the WaveType

Returns:

the WaveType found into registry or null

build

public static WaveTypeBase build(String action,
                 WaveType returnWaveType,
                 WaveItem<?>... waveItems)

Build a wave type.

Parameters:

action - The action to perform "DO_" (by default see JRebirthParameters.WAVE_HANDLER_PREFIX) keyword will be prepended to the action name to generate the handler method

returnWaveType - the return wave Type to call after having processing the current

waveItems - the list of WaveItem required by this wave

Returns:

a new fresh wave type object

getUid

public int getUid()

Gets the uid.

Returns:

Returns the uid.

setUid

public void setUid(int uid)

Sets the uid.

Parameters:

uid - The uid to set.

getAction

public String getAction()

Gets the action.

Returns:

Returns the action.

getWaveItemList

public List<WaveItem<?>> getWaveItemList()

Gets the wave item list.

Returns:

Returns the waveItemList.

getItems

public String getItems()

Return the required method parameter list to handle this WaveType.

Returns:

the parameter list (Type1 arg1, Type2 arg2 ...)

getReturnWaveType

public WaveType getReturnWaveType()

Gets the return wave type.

Returns:

the return wave type

setReturnWaveType

public void setReturnWaveType(WaveType returnWaveType)

Sets the return wave type.

Parameters:

returnWaveType - the new return wave type

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object waveType)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object