com.adobe.granite.references

Class Reference

java.lang.Object

com.adobe.granite.references.Reference

Direct Known Subclasses:

ContentReference, LinkReference

@ConsumerType
public class Reference
extends java.lang.Object

A Reference represents a reference to the Resource backing the ReferenceList. References can only be retrieved via a ReferenceList. Each reference has a reference type. The types available are defined by the ReferenceProviders registered in the system and may vary.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Reference(Resource source, Resource target, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
Resource	getSource() Returns the source resource for which the references have been retrieved through the ReferenceProvider.
Resource	getTarget() Returns the target resource of the reference, i.e.
java.lang.String	getType() Returns the reference type of this reference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Reference

public Reference(Resource source,
                 Resource target,
                 java.lang.String type)

Method Detail

getSource

public Resource getSource()

Returns the source resource for which the references have been retrieved through the ReferenceProvider.

Returns:

The source resource.

getTarget

public Resource getTarget()

Returns the target resource of the reference, i.e. one of the results retrieved by the ReferenceProvider.

Returns:

The target resource.

getType

public java.lang.String getType()

Returns the reference type of this reference.

Returns:

The reference type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object