public final class FilterBuilder extends Object
FilterProvider
instances.Modifier and Type | Class and Description |
---|---|
static interface |
FilterBuilder.Condition |
Constructor and Description |
---|
FilterBuilder() |
Modifier and Type | Method and Description |
---|---|
FilterBuilder.Condition |
accessControl(PermissionProviderFactory permissionProviderFactory)
A condition that hold for accessible items as determined by the passed permission
provider.
|
FilterBuilder.Condition |
addSubtree() |
FilterBuilder |
addSubTree(String absPath)
Adds a path to the set of paths whose subtrees include all events of
this filter.
|
FilterBuilder.Condition |
all(FilterBuilder.Condition... conditions)
A compound condition that holds when all of its constituents hold.
|
FilterBuilder.Condition |
all(Iterable<FilterBuilder.Condition> conditions)
A compound condition that holds when all of its constituents hold.
|
FilterBuilder.Condition |
all(List<FilterBuilder.Condition> conditions)
A compound condition that holds when all of its constituents hold.
|
FilterBuilder.Condition |
any(FilterBuilder.Condition... conditions)
A compound condition that holds when any of its constituents hold.
|
FilterBuilder.Condition |
any(Iterable<FilterBuilder.Condition> conditions)
A compound condition that holds when any of its constituents hold.
|
FilterProvider |
build()
Create a
FilterProvider reflecting the current state of this builder. |
FilterBuilder |
condition(FilterBuilder.Condition condition)
Set the condition of this filter.
|
FilterBuilder.Condition |
deleteSubtree() |
FilterBuilder.Condition |
eventType(int eventTypes)
A condition that holds for matching event types.
|
FilterBuilder.Condition |
excludeAll()
A condition that never holds
|
FilterBuilder.Condition |
includeAll()
A condition the always holds
|
FilterBuilder |
includeClusterExternal(boolean include)
Whether to include cluster external changes.
|
FilterBuilder |
includeClusterLocal(boolean include)
Whether to include cluster local changes.
|
FilterBuilder |
includeSessionLocal(boolean include)
Whether to include session local changes.
|
FilterBuilder.Condition |
moveSubtree() |
FilterBuilder.Condition |
nodeType(UniversalFilter.Selector selector,
String[] ntNames)
A condition that holds for matching node types.
|
FilterBuilder.Condition |
not(FilterBuilder.Condition condition)
A compound condition that holds when its constituent does not hold.
|
FilterBuilder.Condition |
path(String pathPattern)
A condition that holds on the paths matching a certain pattern.
|
FilterBuilder.Condition |
property(UniversalFilter.Selector selector,
String name,
A condition that holds when the property predicate matches.
|
FilterBuilder.Condition |
universal(UniversalFilter.Selector selector,
A condition that holds when the predicate matches.
|
FilterBuilder.Condition |
uuid(UniversalFilter.Selector selector,
String[] uuids)
A condition that holds for matching uuids.
|
public FilterBuilder addSubTree(String absPath)
This is used for optimisation in order to restrict traversal to these sub trees.
absPath
- absolute pathpublic FilterBuilder includeSessionLocal(boolean include)
false
.include
- if true
session local changes are included,
otherwise session local changes are not included.public FilterBuilder includeClusterExternal(boolean include)
false
.include
- if true
cluster external changes are included,
otherwise cluster external changes are not included.public FilterBuilder includeClusterLocal(boolean include)
true
.include
- if true
cluster local changes are included,
otherwise cluster local changes are not included.public FilterBuilder condition(FilterBuilder.Condition condition)
Condition
instance.condition
- the conditions to applypublic FilterBuilder.Condition includeAll()
public FilterBuilder.Condition excludeAll()
public FilterBuilder.Condition accessControl(PermissionProviderFactory permissionProviderFactory)
permissionProviderFactory
- permission provider for checking whether an item is accessible.ACFilter
public FilterBuilder.Condition path(String pathPattern)
pathPattern
- GlobbingPathFilter
public FilterBuilder.Condition eventType(int eventTypes)
eventTypes
- EventTypeFilter
public FilterBuilder.Condition nodeType(UniversalFilter.Selector selector, String[] ntNames)
selector
- selector selecting the node to check the condition onntNames
- node type names to match. This conditions never matches if null
and
always matches if empty.public FilterBuilder.Condition uuid(UniversalFilter.Selector selector, String[] uuids)
selector
- selector selecting the node to check the condition onuuids
- uuids to match. This conditions never matches if null
and
always matches if empty.public FilterBuilder.Condition property(UniversalFilter.Selector selector, String name,predicate)
selector
- selector selecting the node to check the condition onname
- the name of the property to check the predicate onpredicate
- the predicate to check on the named propertypublic FilterBuilder.Condition universal(UniversalFilter.Selector selector,predicate)
selector
- selector selecting the node to check the condition onpredicate
- the predicate to check on the selected nodepublic FilterBuilder.Condition addSubtree()
public FilterBuilder.Condition deleteSubtree()
public FilterBuilder.Condition moveSubtree()
public FilterBuilder.Condition any(FilterBuilder.Condition... conditions)
conditions
- conditions of which any must hold in order for this condition to holdpublic FilterBuilder.Condition all(FilterBuilder.Condition... conditions)
conditions
- conditions of which all must hold in order for this condition to holdpublic FilterBuilder.Condition all(List<FilterBuilder.Condition> conditions)
conditions
- conditions of which all must hold in order for this condition to holdpublic FilterBuilder.Condition not(FilterBuilder.Condition condition)
condition
- condition which must not hold in order for this condition to holdpublic FilterBuilder.Condition any(Iterable<FilterBuilder.Condition> conditions)
conditions
- conditions of which any must hold in order for this condition to holdpublic FilterBuilder.Condition all(Iterable<FilterBuilder.Condition> conditions)
conditions
- conditions of which all must hold in order for this condition to holdpublic FilterProvider build()
FilterProvider
reflecting the current state of this builder."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"