org.jrebirth.af.api.link

Interface CommandReady

All Known Subinterfaces:

Behavior<D,C>, BehavioredComponent<C>, Command, CommandBean<WB>, Component<R>, FacadeReady<R>, FXMLModel, Model, ModelObject<O>, ModelReady, ModuleModel, MultiCommand<WB>, Service, ServiceReady

public interface CommandReady

The class CommandReady.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
Wave	callCommand(Class<? extends Command> commandClass, WaveData<?>... data) Send a wave used to call a command.
Wave	callCommand(Class<? extends CommandBean<? extends WaveBean>> commandClass, WaveBean waveBean, WaveBean... waveBeans) Send a wave used to call a command.
<C extends Command> C	getCommand(Class<C> clazz, Object... keyPart) Return the command singleton or part of multiton.
<C extends Command> C	getCommand(UniqueKey<C> commandKey) Return the command singleton or part of multiton according to UniqueKey.
<C extends Command> List<C>	getCommands(Class<C> clazz, Object... keyPart) Return the list of command singleton or part of multiton.
<C extends Command> List<C>	getCommands(UniqueKey<C> commandKey) Return the list of command singleton or part of multiton according to UniqueKey.

Method Detail

getCommand

<C extends Command> C getCommand(Class<C> clazz,
                                 Object... keyPart)

Return the command singleton or part of multiton.

Type Parameters:

C - a sub class of command

Parameters:

clazz - the service class to find

keyPart - the unique key (in option)

Returns:

a command instance

getCommand

<C extends Command> C getCommand(UniqueKey<C> commandKey)

Return the command singleton or part of multiton according to UniqueKey.

Type Parameters:

C - a sub class of Command

Parameters:

commandKey - the key that describe the searched Command component

Returns:

a command instance

getCommands

<C extends Command> List<C> getCommands(Class<C> clazz,
                                        Object... keyPart)

Return the list of command singleton or part of multiton.

Type Parameters:

C - a sub class of command

Parameters:

clazz - the service class to find

keyPart - the unique key (in option)

Returns:

a list of command instance

getCommands

<C extends Command> List<C> getCommands(UniqueKey<C> commandKey)

Return the list of command singleton or part of multiton according to UniqueKey.

Type Parameters:

C - a sub class of Command

Parameters:

commandKey - the key that describe the searched Command component

Returns:

a list of command instance

callCommand

Wave callCommand(Class<? extends Command> commandClass,
                 WaveData<?>... data)

Send a wave used to call a command. The command will be called from JRebirthThread and could execute itself from another thread.

Parameters:

commandClass - the command class to call

data - the data to transport

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

callCommand

Wave callCommand(Class<? extends CommandBean<? extends WaveBean>> commandClass,
                 WaveBean waveBean,
                 WaveBean... waveBeans)

Send a wave used to call a command. The command will be called from JRebirthThread and could execute itself from another thread.

Type Parameters:

WB - the type of the wave bean to used

Parameters:

commandClass - the command class to call

waveBean - the WaveBean that holds all required data

waveBeans - the extra Wave Beans that holds all other required data

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects