org.jrebirth.af.api.key

Interface UniqueKey<R>

Type Parameters:

R - the type of the classfield managed by this key

All Superinterfaces:

Serializable

public interface UniqueKey<R>
extends Serializable

The class UniqueKey.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
Class<R>	classField() Return the class type of the component.
String	key() Return the unique key.
List<Object>	optionalData() Return the list of optional data associated to the key.
UniqueKey<? super R>	registrationKey() Gets the registration key.
void	registrationKey(UniqueKey<? super R> registrationKey) Sets the registration key.
Object	value() Return the unique object if any or null.

Method Detail

key

String key()

Return the unique key.

Returns:

the unique key

value

Object value()

Return the unique object if any or null.

Returns:

the unique object or null if none

classField

Class<R> classField()

Return the class type of the component.

Returns:

Returns the classField.

optionalData

List<Object> optionalData()

Return the list of optional data associated to the key.

Returns:

the optional data list

registrationKey

void registrationKey(UniqueKey<? super R> registrationKey)

Sets the registration key.

Parameters:

registrationKey - the new registration key

registrationKey

UniqueKey<? super R> registrationKey()

Gets the registration key.

Returns:

the registration key