org.jrebirth.af.api.link

Interface ServiceReady

All Superinterfaces:

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

public interface ServiceReady
extends CommandReady

The interface ServiceReady.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
<S extends Service> S	getService(Class<S> clazz, Object... keyPart) Return the service singleton or part of multiton.
<S extends Service> S	getService(UniqueKey<S> serviceKey) Return the service singleton or part of multiton according to UniqueKey.
<S extends Service> List<S>	getServices(Class<S> clazz, Object... keyPart) Return the list of service singleton or part of multiton.
<S extends Service> List<S>	getServices(UniqueKey<S> serviceKey) Return the list of service singleton or part of multiton according to UniqueKey.
Wave	returnData(Class<? extends Service> serviceClass, WaveType waveType, WaveData<?>... data) Send a wave used to return data from a service.
<WB extends WaveBean> Wave	returnData(Class<? extends Service> serviceClass, WaveType waveType, WB waveBean) Send a wave used to return data from a service.

Methods inherited from interface org.jrebirth.af.api.link.CommandReady

callCommand, callCommand, getCommand, getCommand, getCommands, getCommands

Method Detail

getService

<S extends Service> S getService(Class<S> clazz,
                                 Object... keyPart)

Return the service singleton or part of multiton.

Type Parameters:

S - a sub class of service

Parameters:

clazz - the service class to find

keyPart - the unique key (in option)

Returns:

a service instance

getService

<S extends Service> S getService(UniqueKey<S> serviceKey)

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

Type Parameters:

S - a sub class of Service

Parameters:

serviceKey - the key that describe the searched Service component

Returns:

a service instance

getServices

<S extends Service> List<S> getServices(Class<S> clazz,
                                        Object... keyPart)

Return the list of service singleton or part of multiton.

Type Parameters:

S - a sub class of service

Parameters:

clazz - the service class to find

keyPart - the unique key (in option)

Returns:

a list of service instance

getServices

<S extends Service> List<S> getServices(UniqueKey<S> serviceKey)

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

Type Parameters:

S - a sub class of Service

Parameters:

serviceKey - the key that describe the searched Service component

Returns:

a list of service instance

returnData

<WB extends WaveBean> Wave returnData(Class<? extends Service> serviceClass,
                                      WaveType waveType,
                                      WB waveBean)

Send a wave used to return data from a service. The service will be called from JRebirthThread and could execute itself from another thread.

Type Parameters:

WB - the type of the wave bean to used

Parameters:

serviceClass - the service called

waveType - the type of the wave

waveBean - the WaveBean that holds all required wave data

Returns:

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

returnData

Wave returnData(Class<? extends Service> serviceClass,
                WaveType waveType,
                WaveData<?>... data)

Send a wave used to return data from a service. The service will be called from JRebirthThread and could execute itself from another thread.

Parameters:

serviceClass - the service called

waveType - the type of the wave

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