Package com.adobe.granite.references

Interface ReferenceAggregator

@ProviderType
public interface ReferenceAggregator

The ReferenceAggregator is an OSGi-service providing creation of References for the given resource. The service can be obtained from the OSGi service registry via the interface.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
ReferenceList	createReferenceList(Resource resource)	Create a ReferenceList for the given resource.
ReferenceList	createReferenceList(Resource resource, java.lang.String... types)	Create a ReferenceList for the given resource.
java.util.Set<java.lang.String>	getTypes()	Returns a set of all known references types.

Method Detail

createReferenceList

ReferenceList createReferenceList(Resource resource)

Create a ReferenceList for the given resource.

Parameters:

resource - The Resource for which to create a ReferenceList.

Returns:

The ReferenceList.

createReferenceList

ReferenceList createReferenceList(Resource resource,
                                  java.lang.String... types)

Create a ReferenceList for the given resource.

Parameters:

resource - The Resource for which to create a ReferenceList.

types - An array of Strings corresponding to references types to consider.

Returns:

The ReferenceList.

getTypes

java.util.Set<java.lang.String> getTypes()

Returns a set of all known references types. The types are provided by the registered ReferenceProviders.

Returns:

A Set of references types and their keys (names) - or an empty set if no providers are registered.