org.jrebirth.af.api.wave.contract

Interface WaveType

public interface WaveType

The interface WaveType could be used to create a type that return an action name and hold WaveItem parameters.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
String	action() Return the current action name.
WaveType	action(String action) Set the action name.
List<WaveItem<?>>	items() Return all WaveItems used by this WaveType.
WaveType	items(WaveItem<?>... items) Set all WaveItems used by the current WaveType used as parameter during wave handling.
WaveType	onException(Class<? extends Command> exceptionCommandClass, Class<? extends Throwable>... exceptionTypes) Define the Command to call in order to handle given exception types.
WaveType	onException(WaveType exceptionWaveType, Class<? extends Throwable>... exceptionTypes) Define the WaveType to send in order to manage given exception types.
List<WaveItem<?>>	parameters() Return only WaveItem that can be used as method parameter.
String	returnAction() Return the return Wave Type action name.
WaveType	returnAction(String action) Set the return Wave Type action name.
Class<? extends Command>	returnCommandClass() Return the Command to call in order to process the returned value.
WaveType	returnCommandClass(Class<? extends Command> returnCommandClass) Set the Command to call in order to process the returned value.
WaveItem<?>	returnItem() Set the WaveItem returned.
WaveType	returnItem(WaveItem<?> returnItem) Set the WaveItem that hold the type sent to hold the current WaveType result.
WaveType	returnWaveType() Return the WaveType emitted as the result of the current WaveType.
WaveType	returnWaveType(WaveType returnWaveType) Set the WaveType that will be used a return, override returnItem and returnAction.
int	uid() Return the unique identifier of the WaveType.
WaveType	uid(int uid) Sets the unique identifier of the WaveType.
Map<Class<? extends Throwable>,Wave>	waveExceptionHanler() Return the map of wave exception handler.

Method Detail

uid

int uid()

Return the unique identifier of the WaveType.

Returns:

the unique identifier

uid

WaveType uid(int uid)

Sets the unique identifier of the WaveType.

Parameters:

uid - the uid to set

Returns:

the wave type to chain method call

action

String action()

Return the current action name.

Returns:

the action name

action

WaveType action(String action)

Set the action name.

Parameters:

action - the action name to set

Returns:

the wave type to chain method call

items

List<WaveItem<?>> items()

Return all WaveItems used by this WaveType.

Returns:

the wave items list

items

WaveType items(WaveItem<?>... items)

Set all WaveItems used by the current WaveType used as parameter during wave handling.

Parameters:

items - the wave items to set

Returns:

the wave type to chain method call

returnAction

String returnAction()

Return the return Wave Type action name.

Returns:

the return action name

returnAction

WaveType returnAction(String action)

Set the return Wave Type action name.

Parameters:

action - the return action name to set

Returns:

the wave type to chain method call

returnItem

WaveItem<?> returnItem()

Set the WaveItem returned.

Returns:

the wave item returned

returnItem

WaveType returnItem(WaveItem<?> returnItem)

Set the WaveItem that hold the type sent to hold the current WaveType result.

Parameters:

returnItem - the return WaveItem to set

Returns:

the wave type to chain method call

returnWaveType

WaveType returnWaveType()

Return the WaveType emitted as the result of the current WaveType.

Returns:

the wave type to call after the processing of the current WaveType

returnWaveType

WaveType returnWaveType(WaveType returnWaveType)

Set the WaveType that will be used a return, override returnItem and returnAction.

Parameters:

returnWaveType - the return WaveType to set

Returns:

the wave type to chain method call

returnCommandClass

WaveType returnCommandClass(Class<? extends Command> returnCommandClass)

Set the Command to call in order to process the returned value.

Parameters:

returnCommandClass - the command class to set

Returns:

the wave type to chain method call

returnCommandClass

Class<? extends Command> returnCommandClass()

Return the Command to call in order to process the returned value.

Returns:

the command class to call

parameters

List<WaveItem<?>> parameters()

Return only WaveItem that can be used as method parameter.

Returns:

eligible method parameters

waveExceptionHanler

Map<Class<? extends Throwable>,Wave> waveExceptionHanler()

Return the map of wave exception handler.

Returns:

the waveExceptionHandler map

onException

WaveType onException(Class<? extends Command> exceptionCommandClass,
                     Class<? extends Throwable>... exceptionTypes)

Define the Command to call in order to handle given exception types.

Parameters:

exceptionCommandClass - the command class to use

exceptionTypes - the types of exception to manage (none = all)

Returns:

the wave type to chain method call

onException

WaveType onException(WaveType exceptionWaveType,
                     Class<? extends Throwable>... exceptionTypes)

Define the WaveType to send in order to manage given exception types.

Parameters:

exceptionWaveType - the WaveType to send to handle the exception

exceptionTypes - the types of exception to manage (none = all)

Returns:

the wave type to chain method call