com.adobe.granite.references

Interface ReferenceProvider

All Known Implementing Classes:

FormsReferenceProvider

@ConsumerType
public interface ReferenceProvider

A ReferenceProvider provides References of a ReferenceList. Implementations must register themselves as an OSGi-component and declare themselves as a service on this interface. This way the reference aggregator service is able to dynamically use available providers to retrieve references for a given Resource. References are provided via getReferences(Resource).

Since:

1.0

Method Summary

Modifier and Type	Method and Description
java.util.List<Reference>	getReferences(Resource resource) Provides a Collection of References for the given resource.
java.lang.String	getType() Returns the type of references this provider provides.

Method Detail

getReferences

java.util.List<Reference> getReferences(Resource resource)

Provides a Collection of References for the given resource.

Parameters:

resource - The Resource for which to return References.

Returns:

A List of References or an empty list if the provider did not find/generate any reference items.

getType

java.lang.String getType()

Returns the type of references this provider provides.

Returns:

The type of references this provider provides.