org.jboss.cache.pojo
Interface Reference

All Known Implementing Classes:
ReferenceImpl

public interface Reference

A reference to an attached object. This class represents both normal Fqn aliases, and references from other attached objects.

Author:
Dan Berindei

Method Summary
 org.jboss.cache.Fqn<?> getFqn()
          Returns the Fqn of the referring node.
 String getKey()
          Returns the name of the node key which references the attached object, or null if the Fqn is a normal alias to the internal node.
 

Method Detail

getFqn

org.jboss.cache.Fqn<?> getFqn()
Returns the Fqn of the referring node. Cannot be null.

Returns:
Fqn of the referring node.

getKey

String getKey()
Returns the name of the node key which references the attached object, or null if the Fqn is a normal alias to the internal node. If there is a key, then this is typically a field name or collection index.

Returns:
Name of the field or key/index in the collection that is containing the reference.


Copyright © 2008 JBoss, a division of Red Hat. All Rights Reserved.