org.jrebirth.af.core.key

Interface Key

All Superinterfaces:

Serializable

public interface Key
extends Serializable

The class Key used as a key factory.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
static <C> UniqueKey<C>	create(Class<C> clazz, Object... keyPart) Build an unique key.
static <C> UniqueKey<C>	create(Class<C> clazz, Object[] optionalData, Object... keyPart) Build an unique key.
static <C> UniqueKey<C>	createMulti(Class<C> clazz, Object... keyPart) Build a multiton key.
static <C> UniqueKey<C>	createMulti(Class<C> clazz, Object[] keyPart, Object... optionalData) Build a multiton key.
static <C> UniqueKey<C>	createSingle(Class<C> clazz, Object... optionalData) Build a singleton key.

Method Detail

create

static <C> UniqueKey<C> create(Class<C> clazz,
                               Object... keyPart)

Build an unique key.

Type Parameters:

C - 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

create

static <C> UniqueKey<C> create(Class<C> clazz,
                               Object[] optionalData,
                               Object... keyPart)

Build an unique key.

Type Parameters:

C - The type of the object registered by this ClassKey

Parameters:

clazz - the class type of the component

optionalData - the optional data to be transmit to the component

keyPart - all complementary part of the key

Returns:

the unique key for the given class and keyParts array

createSingle

static <C> UniqueKey<C> createSingle(Class<C> clazz,
                                     Object... optionalData)

Build a singleton key.

Type Parameters:

C - The type of the object registered by this ClassKey

Parameters:

clazz - the class type of the component

optionalData - the optional data to be transmit to the component

Returns:

the unique key for a singleton

createMulti

static <C> UniqueKey<C> createMulti(Class<C> clazz,
                                    Object... keyPart)

Build a multiton key.

Type Parameters:

C - 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 a multiton

createMulti

static <C> UniqueKey<C> createMulti(Class<C> clazz,
                                    Object[] keyPart,
                                    Object... optionalData)

Build a multiton key.

Type Parameters:

C - The type of the object registered by this ClassKey

Parameters:

clazz - the class type of the component

keyPart - all complementary part of the key

optionalData - the optional data to be transmit to the component

Returns:

the unique key for a multiton