org.jrebirth.af.core.key

Class MultitonKey<R>

java.lang.Object

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

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

Type Parameters:

R - the type of the object registered by this key

All Implemented Interfaces:

KeyMessages, UniqueKey<R>, MessageContainer

public class MultitonKey<R>
extends ClassKey<R>
implements KeyMessages

The class MultitonKey. The key used to discriminate any multiton part in order to guarantee component unicity.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private String	key The key formatted into a string.
private List<Object>	keyPartList List of keys that are part of the main key.
private static JRLogger	LOGGER The class logger.

Fields inherited from interface org.jrebirth.af.core.key.KeyMessages

KEY_GENERATOR_FAILURE, METHOD_KEY_GENERATOR_FAILURE, METHOD_KEY_TOSTRING_FAILURE, METHOD_NOT_FOUND, NO_KEY_GENERATOR_METHOD, NO_TOSTRING_KEY_METHOD, NULL_METHOD_KEY, NULL_METHOD_KEY_STRING

Constructor Summary

Constructors

Constructor and Description
MultitonKey(Class<R> classField, Object... keyPart) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private String	buildObjectKey(Object object) Generate the string key for an object.
private String	convertMethodKeyObject(KeyGenerator methodGenerator, Object keyValue) Convert the key returned by an annotated method to a string (using annotation value or not).
boolean	equals(Object object)
private String	generateAggregatedKey(Object object) Generate unique key by using the method-level annotations.
private String	generateTypeKey(Object object, KeyGenerator typeGenerator) Generate Type key by using the class-level annotation.
String	getKey() Return the unique key.
Object	getValue() Return the unique object if any or null.
int	hashCode()
private void	rebuildKey() (Re)-Build the string key by reading the keys list content.
String	toString()

Methods inherited from class org.jrebirth.af.core.key.ClassKey

getClassField

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final JRLogger LOGGER

The class logger.

key

private String key

The key formatted into a string.

keyPartList

private final List<Object> keyPartList

List of keys that are part of the main key.

Constructor Detail

MultitonKey

public MultitonKey(Class<R> classField,
           Object... keyPart)

Default Constructor.

Parameters:

classField - the descriptive class object

keyPart - a list of immutable objects that guarantee component unicity

Method Detail

rebuildKey

private void rebuildKey()

(Re)-Build the string key by reading the keys list content.

buildObjectKey

private String buildObjectKey(Object object)

Generate the string key for an object.

Parameters:

object - the object which is part of the global key

Returns:

the unique string for this object

generateTypeKey

private String generateTypeKey(Object object,
                     KeyGenerator typeGenerator)

Generate Type key by using the class-level annotation.

Parameters:

object - the source object

typeGenerator - the annotation that expressed how generate the string unique key

Returns:

the unique key or null if an error occurred

generateAggregatedKey

private String generateAggregatedKey(Object object)

Generate unique key by using the method-level annotations.

Parameters:

object - the source object

Returns:

the unique key or null if an error occurred or no method annotation was found

convertMethodKeyObject

private String convertMethodKeyObject(KeyGenerator methodGenerator,
                            Object keyValue)

Convert the key returned by an annotated method to a string (using annotation value or not).

Parameters:

methodGenerator - the method annotation

keyValue - the returned key value

Returns:

the key converted from object

equals

public boolean equals(Object object)

Overrides:

equals in class ClassKey<R>

hashCode

public int hashCode()

Overrides:

hashCode in class ClassKey<R>

toString

public String toString()

Overrides:

toString in class ClassKey<R>

getKey

public String getKey()

Return the unique key.

Specified by:

getKey in interface UniqueKey<R>

Overrides:

getKey in class ClassKey<R>

Returns:

the unique key

getValue

public Object getValue()

Return the unique object if any or null.

Specified by:

getValue in interface UniqueKey<R>

Overrides:

getValue in class ClassKey<R>

Returns:

the unique object or null if none