Package com.day.cq.wcm.api.reference
Interface ReferenceProvider
-
- All Known Implementing Classes:
AssetReferenceProvider,CanvasReferenceProvider
public interface ReferenceProviderThe ReferencedResourceProvider finds references to a specific resource
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default @NotNull java.util.List<Reference>findReferences(@NotNull Resource resource, boolean onlyValidReferences)Finds references to a specific resourcejava.util.List<Reference>findReferences(Resource resource)Finds references to a specific resource
-
-
-
Method Detail
-
findReferences
java.util.List<Reference> findReferences(Resource resource)
Finds references to a specific resource- Parameters:
resource- the resource to find references to, never null- Returns:
- a list of references, possibly empty but never null
-
findReferences
@NotNull default @NotNull java.util.List<Reference> findReferences(@NotNull @NotNull Resource resource, boolean onlyValidReferences) throws InvalidReferenceException
Finds references to a specific resource- Parameters:
resource- the resource to find references to, never nullonlyValidReferences- if set to true, will retrieve only valid references. a reference is considered valid when it can be retrieved, its fields/properties respect all conditions imposed on them (i.e. regex pattern or unique property)- Returns:
- a list of references, possibly empty but never null
- Throws:
InvalidReferenceException- if any invalid references are found
-
-