org.jrebirth.af.core.facade

Interface Facade<R extends FacadeReady<R>>

Type Parameters:

R - A type that implements FacadeReady

All Known Subinterfaces:

LocalFacade<R>

All Known Implementing Classes:

AbstractFacade, CommandFacade, ServiceFacade, UiFacade

public interface Facade<R extends FacadeReady<R>>

The class Facade. The interface to respect in order to implement a local facade (per pattern type)

Author:

Sébastien Bordes

Method Summary

Methods

Modifier and Type	Method and Description
<E extends R> UniqueKey<E>	buildKey(Class<E> clazz, Object... keyPart) Build an unique key.
<E extends R> boolean	exists(Class<E> clazz, Object... keyPart) Check if the component has already been created and stored.
<E extends R> boolean	exists(UniqueKey<E> uniqueKey) Check if the component has already been created and stored.
<E extends R> void	register(E readyObject, Object... keyPart) Register a new ready object component.
<E extends R> void	register(UniqueKey<E> uniqueKey, E readyObject) Register a new ready object component.
<E extends R> E	retrieve(Class<E> clazz, Object... keyPart) Retrieve a ready object component.
<E extends R> E	retrieve(UniqueKey<E> uniqueKey) Retrieve a ready object component.
<E extends R> void	unregister(E readyObject, Object... keyPart) Unregister a new ready object component.
<E extends R> void	unregister(UniqueKey<E> uniqueKey) Unregister a new ready object component.

Method Detail

register

<E extends R> void register(UniqueKey<E> uniqueKey,
                          E readyObject)

Register a new ready object component.

Type Parameters:

E - the type of the ready object used

Parameters:

uniqueKey - the unique key for the component to get

readyObject - the component to register

register

<E extends R> void register(E readyObject,
                          Object... keyPart)

Register a new ready object component.

Type Parameters:

E - the type of the ready object used

Parameters:

readyObject - the component to register

keyPart - the unique key for multiton FacadeReady element, could be omitted for singleton

unregister

<E extends R> void unregister(UniqueKey<E> uniqueKey)

Unregister a new ready object component.

Type Parameters:

E - the type of the ready object used

Parameters:

uniqueKey - the unique key for the component to get

unregister

<E extends R> void unregister(E readyObject,
                            Object... keyPart)

Unregister a new ready object component.

Type Parameters:

E - the type of the ready object used

Parameters:

readyObject - the component to unregister

keyPart - the unique key for multiton FacadeReady element, could be omitted for singleton

retrieve

<E extends R> E retrieve(UniqueKey<E> uniqueKey)

Retrieve a ready object component.
May allow to build it if it hadn't been done previously

Type Parameters:

E - the type of the ready object to retrieve

Parameters:

uniqueKey - the unique key for the component to get

Returns:

the singleton of the component

retrieve

<E extends R> E retrieve(Class<E> clazz,
                       Object... keyPart)

Retrieve a ready object component.
May allow to build it if it hadn't been done previously

Type Parameters:

E - the type of the ready object to retrieve

Parameters:

clazz - the component class

keyPart - the unique key for multiton FacadeReady element, could be omitted for singleton

Returns:

the singleton of the component

exists

<E extends R> boolean exists(UniqueKey<E> uniqueKey)

Check if the component has already been created and stored.

Type Parameters:

E - The type of the object registered by this ClassKey

Parameters:

uniqueKey - the unique key for the component to get

Returns:

true if the component exists

exists

<E extends R> boolean exists(Class<E> clazz,
                           Object... keyPart)

Check if the component has already been created and stored.

Type Parameters:

E - The type of the object registered by this ClassKey

Parameters:

clazz - the component class to check

keyPart - the unique key for multiton FacadeReady element, could be omitted for singleton

Returns:

true if the component exists

buildKey

<E extends R> UniqueKey<E> buildKey(Class<E> clazz,
                                  Object... keyPart)

Build an unique key.

Type Parameters:

E - The type of the object registered by this ClassKey

Parameters:

clazz - the class type of the component

keyPart - all complementary part of the key

Returns:

the unique key for the given class and keyParts array