com.oracle.common.base

Interface Associated<T>

Type Parameters:

T - the type of associated key

All Known Subinterfaces:

KeyAssociation<T>

All Known Implementing Classes:

AbstractPersistenceManager.AbstractPersistentStore.BatchTask, CompositeKey, NonBlockingFiniteStateMachine.Task

public interface Associated<T>

The Associated interface facilitates the creation of a very generic equivalence relation between different objects and allows to group them based on the equality of the "association key" object returned by the getAssociatedKey() method.

Author:

gg 2012.03.11

See Also:

Associator

Method Summary

Modifier and Type	Method and Description
T	getAssociatedKey() Determine the host key (or base) object to which this object is associated.

Method Detail

getAssociatedKey

T getAssociatedKey()

Determine the host key (or base) object to which this object is associated.

Note: It's expected that the returned object is suitable to be used as an immutable identity (e.g. a key in a Map).
Note 2: Circular associations are not permitted.

Returns:

the host key that for this object, or null if this object has no association