org.apache.sling.resource.filter

Interface ResourcePredicates

All Known Subinterfaces:

ResourcePredicates.ResourcePredicateBuilder

All Known Implementing Classes:

ResourcePredicateImpl, ResourcePredicateImpl.ResourcePredicateBuilderImpl

@ProviderType
public interface ResourcePredicates

Service which provides the ability to convert a String into a Predicate to match against Resource Objects

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResourcePredicates.ResourcePredicateBuilder Provides a transitional state where multiple parameters can be applied before creating the Predicate

Method Summary

Modifier and Type	Method and Description
Predicate<org.apache.sling.api.resource.Resource>	parse(String filter) Creates a Predicate based on the provided script
Predicate<org.apache.sling.api.resource.Resource>	parse(String filter, String charEncoding) Creates a Predicate based on the provided script
ResourcePredicates.ResourcePredicateBuilder	usingParameterMap(Map<String,Object> params) Replaces the existing parameter map with the supplied Map object, all prior provided parameters will be replaced
ResourcePredicates.ResourcePredicateBuilder	withParameter(String key, Object value) Adds a key - value pair that can then be evaluated as part of the Predicate creation
ResourcePredicates.ResourcePredicateBuilder	withParameters(Map<String,Object> params) Add a series of key - value pairs that can then be evaluated as part of the Predicate creation

Method Detail

parse

Predicate<org.apache.sling.api.resource.Resource> parse(String filter)

Creates a Predicate based on the provided script

Parameters:

filter -

Returns:

Throws:

ResourceFilterException

parse

Predicate<org.apache.sling.api.resource.Resource> parse(String filter,
                                                        String charEncoding)

Creates a Predicate based on the provided script

Parameters:

filter -

charEncoding -

Returns:

Throws:

ResourceFilterException

withParameters

ResourcePredicates.ResourcePredicateBuilder withParameters(Map<String,Object> params)

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

Parameters:

params - Map of Key - Value pairs

Returns:

ResourcePredicateBuilder

withParameter

ResourcePredicates.ResourcePredicateBuilder withParameter(String key,
                                                          Object value)

Adds a key - value pair that can then be evaluated as part of the Predicate creation

Parameters:

key -

value -

Returns:

ResourcePredicateBuilder

usingParameterMap

ResourcePredicates.ResourcePredicateBuilder usingParameterMap(Map<String,Object> params)

Replaces the existing parameter map with the supplied Map object, all prior provided parameters will be replaced

Returns:

ResourcePredicateBuilder