org.apache.sling.resource.filter

Class ResourceFilterStream

java.lang.Object

org.apache.sling.resource.filter.ResourceFilterStream

@ProviderType
public class ResourceFilterStream
extends java.lang.Object

Creates a Predicate of type Resource to identify matching Resource objects

Constructor Summary

Constructors

Constructor and Description
ResourceFilterStream(Resource resource, ResourcePredicates filter)

Method Summary

Modifier and Type	Method and Description
ResourceFilterStream	addParam(java.lang.String key, java.lang.Object value) Add a key - value pair that can then be evaluated as part of the Script
ResourceFilterStream	addParams(java.util.Map<java.lang.String,java.lang.Object> params) Add a series of key - value pairs that can then be evaluated as part of the ScriptFilter
ResourceFilterStream	setBranchSelector(java.lang.String branchSelector) Adds a branchSelector to define which child resource are acceptable to travel down as part of the Resource traversal
ResourceFilterStream	setChildSelector(java.lang.String childSelector) Adds a childSelector to define which child resources should be part of the stream
java.util.stream.Stream<Resource>	stream() Stream which uses the branchSelector as the basis of the traversal and then filters the resources based on the childSelector that was provided

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceFilterStream

public ResourceFilterStream(Resource resource,
                            ResourcePredicates filter)

Method Detail

setBranchSelector

public ResourceFilterStream setBranchSelector(java.lang.String branchSelector)

Adds a branchSelector to define which child resource are acceptable to travel down as part of the Resource traversal

Parameters:

branchSelector - resourcePredicate script for traversal control

Returns:

ResourceStreamFilter

Throws:

ResourceFilterException

setChildSelector

public ResourceFilterStream setChildSelector(java.lang.String childSelector)

Adds a childSelector to define which child resources should be part of the stream

Parameters:

childSelector - resourcePredicate script to identify child resources to return

Returns:

ResourceStreamFilter

Throws:

ResourceFilterException

addParam

public ResourceFilterStream addParam(java.lang.String key,
                                     java.lang.Object value)

Add a key - value pair that can then be evaluated as part of the Script

Parameters:

params -

Returns:

addParams

public ResourceFilterStream addParams(java.util.Map<java.lang.String,java.lang.Object> params)

Add a series of key - value pairs that can then be evaluated as part of the ScriptFilter

Parameters:

params -

Returns:

stream

public java.util.stream.Stream<Resource> stream()

Stream which uses the branchSelector as the basis of the traversal and then filters the resources based on the childSelector that was provided

Returns:

pre filterd Stream