org.jrebirth.af.core.wave

Class WaveBuilder<B extends WaveBuilder<B>>

java.lang.Object

org.jrebirth.af.core.wave.WaveBuilder<B>

Type Parameters:

B - the builder recursive type

All Implemented Interfaces:

Builder<WaveBase>

Direct Known Subclasses:

CommandWaveBuilder

public class WaveBuilder<B extends WaveBuilder<B>>
extends Object
implements Builder<WaveBase>

The class WaveBuilder. Base builder used to build a custom wave.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private long	bitMask The field used to store the property mask (allow up to 64 properties).
private Class<?>	fromClass The from class of the wave to build.
private Class<?>	relatedClass The related class of the wave to build.
private Class<? extends WaveBean>	waveBeanClass The wave bean class of the wave to build.
private WaveData<?>[]	waveData The list of Wave Data.
private WaveGroup	waveGroup The wave group of the wave to build.
private WaveType	waveType The wave type of the wave to build.

Constructor Summary

Constructors

Constructor and Description
WaveBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBit(int bit) Add a bit to the mask.
void	applyTo(WaveBase paramWave) Apply all wave properties.
WaveBase	build()
static WaveBuilder<?>	create() Create a WaveBuilder instance.
B	data(WaveData<?>... waveData) Define the list of WaveData.
B	fromClass(Class<?> fromClass) Define the from class.
protected boolean	hasBit(int bit) Check if the mask contains the requested bit.
B	relatedClass(Class<?> relatedClass) Define the related class.
B	waveBeanClass(Class<? extends WaveBean> waveBeanClass) Define the wave bean class.
B	waveGroup(WaveGroup waveGroup) Define the wave group.
B	waveType(WaveType waveType) Define the wave type.

Methods inherited from class java.lang.Object

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

Field Detail

bitMask

private long bitMask

The field used to store the property mask (allow up to 64 properties).

waveGroup

private WaveGroup waveGroup

The wave group of the wave to build.

waveType

private WaveType waveType

The wave type of the wave to build.

fromClass

private Class<?> fromClass

The from class of the wave to build.

relatedClass

private Class<?> relatedClass

The related class of the wave to build.

waveBeanClass

private Class<? extends WaveBean> waveBeanClass

The wave bean class of the wave to build.

waveData

private WaveData<?>[] waveData

The list of Wave Data.

Constructor Detail

WaveBuilder

public WaveBuilder()

Method Detail

create

public static WaveBuilder<?> create()

Create a WaveBuilder instance.

Returns:

new instance of WaveBuilder

applyTo

public void applyTo(WaveBase paramWave)

Apply all wave properties.

Parameters:

paramWave - the wave that need to be initialized with builder values

waveGroup

public B waveGroup(WaveGroup waveGroup)

Define the wave group. Default value is WaveGroup.UNDEFINED

Parameters:

waveGroup - the wave group to set

Returns:

the builder

waveType

public B waveType(WaveType waveType)

Define the wave type.

Parameters:

waveType - the wave type to set

Returns:

the builder

fromClass

public B fromClass(Class<?> fromClass)

Define the from class.

Parameters:

fromClass - the from class to set

Returns:

the builder

relatedClass

public B relatedClass(Class<?> relatedClass)

Define the related class.

Parameters:

relatedClass - the related class to set

Returns:

the builder

waveBeanClass

public B waveBeanClass(Class<? extends WaveBean> waveBeanClass)

Define the wave bean class.

Parameters:

waveBeanClass - the wave bean class to set

Returns:

the builder

data

public B data(WaveData<?>... waveData)

Define the list of WaveData.

Parameters:

waveData - the list of waveData to set

Returns:

the builder

build

public WaveBase build()

Specified by:

build in interface Builder<WaveBase>

addBit

protected void addBit(int bit)

Add a bit to the mask.

Parameters:

bit - the bit to add

hasBit

protected boolean hasBit(int bit)

Check if the mask contains the requested bit.

Parameters:

bit - the requested bit

Returns:

true if the mask contains the requested bit