org.jrebirth.af.core.command.basic.stage

Class StageWaveBuilder

java.lang.Object

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

org.jrebirth.af.core.command.CommandWaveBuilder<StageWaveBuilder,StageWaveBean>

org.jrebirth.af.core.command.basic.stage.StageWaveBuilder

All Implemented Interfaces:

Builder<WaveBase>

public final class StageWaveBuilder
extends CommandWaveBuilder<StageWaveBuilder,StageWaveBean>

The class StageWaveBuilder. is used to build a new Stage Wave.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private StageAction	action The action to perform for this stage.
private Class<? extends Model>	rootModelClass The root model class to show attached to the stage.
private String	stageKey The unique key used to identify a stage.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StageWaveBuilder() Private constructor.

Method Summary

Methods

Modifier and Type	Method and Description
StageWaveBuilder	action(StageAction action) Define action to process.
void	applyTo(WaveBase paramWave) Apply all wave properties.
static StageWaveBuilder	create() Static method to build a default builder.
StageWaveBuilder	key(String stageKey) Define action to process.
StageWaveBuilder	rootModelClass(Class<? extends Model> rootModelClass) Define the root model class.

Methods inherited from class org.jrebirth.af.core.command.CommandWaveBuilder

getWaveBean

Methods inherited from class org.jrebirth.af.core.wave.WaveBuilder

addBit, build, data, fromClass, hasBit, relatedClass, waveBeanClass, waveGroup, waveType

Methods inherited from class java.lang.Object

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

Field Detail

stageKey

private String stageKey

The unique key used to identify a stage.

action

private StageAction action

The action to perform for this stage.

rootModelClass

private Class<? extends Model> rootModelClass

The root model class to show attached to the stage.

Constructor Detail

StageWaveBuilder

private StageWaveBuilder()

Private constructor.

Method Detail

create

public static StageWaveBuilder create()

Static method to build a default builder.

Returns:

a new fresh OpenStageWaveBuilder instance

applyTo

public void applyTo(WaveBase paramWave)

Apply all wave properties.

Overrides:

applyTo in class CommandWaveBuilder<StageWaveBuilder,StageWaveBean>

Parameters:

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

key

public StageWaveBuilder key(String stageKey)

Define action to process.

Parameters:

stageKey - the stage key

Returns:

the builder

action

public StageWaveBuilder action(StageAction action)

Define action to process.

Parameters:

action - the action to perform StageAction

Returns:

the builder

rootModelClass

public StageWaveBuilder rootModelClass(Class<? extends Model> rootModelClass)

Define the root model class.

Parameters:

rootModelClass - the root model class

Returns:

the builder