com.icfolson.aem.library.api

Interface Traversable<T>

Type Parameters:

T - type of traversable resource

All Known Subinterfaces:

ComponentNode, PageDecorator

All Known Implementing Classes:

AbstractComponent, DelegateComponentNode

public interface Traversable<T>

Definition for hierarchical JCR resources that can be traversed.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<T>	findAncestor(com.google.common.base.Predicate<T> predicate) Find the first ancestor resource that matches the given predicate condition.
com.google.common.base.Optional<T>	findAncestor(com.google.common.base.Predicate<T> predicate, boolean excludeCurrentResource) Find the first ancestor resource that matches the given predicate condition.
com.google.common.base.Optional<T>	findAncestorWithProperty(String propertyName) Find the first ancestor resource containing the given property name.
com.google.common.base.Optional<T>	findAncestorWithProperty(String propertyName, boolean excludeCurrentResource) Find the first ancestor resource containing the given property name.
<V> com.google.common.base.Optional<T>	findAncestorWithPropertyValue(String propertyName, V propertyValue) Find the first ancestor resource where the given property name has the specified value.
<V> com.google.common.base.Optional<T>	findAncestorWithPropertyValue(String propertyName, V propertyValue, boolean excludeCurrentResource) Find the first ancestor resource where the given property name has the specified value.
List<T>	findDescendants(com.google.common.base.Predicate<T> predicate) Get a list of descendant resources that match the given predicate condition.

Method Detail

findAncestor

com.google.common.base.Optional<T> findAncestor(com.google.common.base.Predicate<T> predicate)

Find the first ancestor resource that matches the given predicate condition.

Parameters:

predicate - predicate to match ancestor resources against

Returns:

Optional resource that matches the predicate condition

findAncestor

com.google.common.base.Optional<T> findAncestor(com.google.common.base.Predicate<T> predicate,
                                                boolean excludeCurrentResource)

Find the first ancestor resource that matches the given predicate condition.

Parameters:

predicate - predicate to match ancestor resources against

excludeCurrentResource - if true, the current resource will be excluded (i.e. even if the current resource matches the predicate criteria, it will not be returned)

Returns:

Optional resource that matches the predicate condition

findAncestorWithProperty

com.google.common.base.Optional<T> findAncestorWithProperty(String propertyName)

Find the first ancestor resource containing the given property name.

Parameters:

propertyName - property name to find on ancestor resources

Returns:

Optional resource that contains the property

findAncestorWithProperty

com.google.common.base.Optional<T> findAncestorWithProperty(String propertyName,
                                                            boolean excludeCurrentResource)

Find the first ancestor resource containing the given property name.

Parameters:

propertyName - property name to find on ancestor resources

excludeCurrentResource - if true, the current resource will be excluded (i.e. even if the current resource matches the predicate criteria, it will not be returned)

Returns:

Optional resource that contains the property

findAncestorWithPropertyValue

<V> com.google.common.base.Optional<T> findAncestorWithPropertyValue(String propertyName,
                                                                     V propertyValue)

Find the first ancestor resource where the given property name has the specified value.

Type Parameters:

V - type of value

Parameters:

propertyName - property name to find on ancestor resources

propertyValue - value of named property to match

Returns:

Optional resource that contains the property value

findAncestorWithPropertyValue

<V> com.google.common.base.Optional<T> findAncestorWithPropertyValue(String propertyName,
                                                                     V propertyValue,
                                                                     boolean excludeCurrentResource)

Find the first ancestor resource where the given property name has the specified value.

Type Parameters:

V - type of value

Parameters:

propertyName - property name to find on ancestor resources

propertyValue - value of named property to match

excludeCurrentResource - if true, the current resource will be excluded (i.e. even if the current resource matches the predicate criteria, it will not be returned)

Returns:

Optional resource that contains the property value

findDescendants

List<T> findDescendants(com.google.common.base.Predicate<T> predicate)

Get a list of descendant resources that match the given predicate condition.

Parameters:

predicate - predicate to match descendant resources against

Returns:

list of resources that match the predicate condition or empty list if none exist