org.jrebirth.af.core.key

Class ClassKey<R>

java.lang.Object

org.jrebirth.af.core.key.ClassKey<R>

Type Parameters:

R - the class type of the registered key

All Implemented Interfaces:

Serializable, UniqueKey<R>

Direct Known Subclasses:

MultitonKey

public class ClassKey<R>
extends Object
implements UniqueKey<R>

The class ClassKey.

Author:

Sébastien Bordes

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassKey(Class<R> classField, Object... optionalData) Default Constructor.

Method Summary

Modifier and Type	Method and Description
Class<R>	classField() Return the class type of the component.
boolean	equals(Object obj)
int	hashCode()
String	key() Return the unique key.
List<Object>	optionalData() Return the list of optional data associated to the key.
String	toString()
Object	value() Return the unique object if any or null.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClassKey

public ClassKey(Class<R> classField,
                Object... optionalData)

Default Constructor.

Parameters:

classField - the class type of the registered component

optionalData - the optional data to be transmit to the component

Method Detail

key

public String key()

Return the unique key.

Specified by:

key in interface UniqueKey<R>

Returns:

the unique key

value

public Object value()

Return the unique object if any or null.

Specified by:

value in interface UniqueKey<R>

Returns:

the unique object or null if none

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

classField

public Class<R> classField()

Description copied from interface: UniqueKey

Return the class type of the component.

Specified by:

classField in interface UniqueKey<R>

Returns:

Returns the classField.

optionalData

public List<Object> optionalData()

Return the list of optional data associated to the key.

Specified by:

optionalData in interface UniqueKey<R>

Returns:

the optional data list