public final class FilterBuilder
extends java.lang.Object
FilterProvider
instances.Modifier and Type | Class and Description |
---|---|
static interface |
FilterBuilder.Condition |
Constructor and Description |
---|
FilterBuilder() |
Modifier and Type | Method and Description |
---|---|
@NotNull FilterBuilder.Condition |
accessControl(@NotNull PermissionProviderFactory permissionProviderFactory)
A condition that hold for accessible items as determined by the passed permission
provider.
|
FilterBuilder |
addPathsForMBean(@NotNull java.util.Set<java.lang.String> paths)
Adds paths to the FilterConfigMBean's getPaths set
|
@NotNull FilterBuilder.Condition |
addSubtree() |
@NotNull FilterBuilder |
addSubTree(@NotNull java.lang.String absPath)
Adds a path to the set of paths whose subtrees include all events of
this filter.
|
FilterBuilder |
aggregator(EventAggregator aggregator) |
@NotNull FilterBuilder.Condition |
all(FilterBuilder.Condition... conditions)
A compound condition that holds when all of its constituents hold.
|
@NotNull FilterBuilder.Condition |
all(@NotNull java.lang.Iterable<FilterBuilder.Condition> conditions)
A compound condition that holds when all of its constituents hold.
|
@NotNull FilterBuilder.Condition |
all(@NotNull java.util.List<FilterBuilder.Condition> conditions)
A compound condition that holds when all of its constituents hold.
|
@NotNull FilterBuilder.Condition |
any(FilterBuilder.Condition... conditions)
A compound condition that holds when any of its constituents hold.
|
@NotNull FilterBuilder.Condition |
any(@NotNull java.lang.Iterable<FilterBuilder.Condition> conditions)
A compound condition that holds when any of its constituents hold.
|
@NotNull FilterProvider |
build()
Create a
FilterProvider reflecting the current state of this builder. |
@NotNull FilterBuilder |
condition(@NotNull FilterBuilder.Condition condition)
Set the condition of this filter.
|
@NotNull FilterBuilder.Condition |
deleteSubtree() |
@NotNull FilterBuilder.Condition |
eventType(int eventTypes)
A condition that holds for matching event types.
|
@NotNull FilterBuilder.Condition |
excludeAll()
A condition that never holds
|
@NotNull FilterBuilder.Condition |
includeAll()
A condition the always holds
|
@NotNull FilterBuilder |
includeClusterExternal(boolean include)
Whether to include cluster external changes.
|
@NotNull FilterBuilder |
includeClusterLocal(boolean include)
Whether to include cluster local changes.
|
@NotNull FilterBuilder |
includeSessionLocal(boolean include)
Whether to include session local changes.
|
@NotNull FilterBuilder.Condition |
moveSubtree() |
@NotNull FilterBuilder.Condition |
nodeType(@NotNull UniversalFilter.Selector selector,
@Nullable java.lang.String[] ntNames)
A condition that holds for matching node types.
|
@NotNull FilterBuilder.Condition |
not(@NotNull FilterBuilder.Condition condition)
A compound condition that holds when its constituent does not hold.
|
@NotNull FilterBuilder.Condition |
path(@NotNull java.lang.String pathPattern)
A condition that holds on the paths matching a certain pattern.
|
@NotNull FilterBuilder.Condition |
property(@NotNull UniversalFilter.Selector selector,
@NotNull java.lang.String name,
@NotNull com.google.common.base.Predicate<PropertyState> predicate)
A condition that holds when the property predicate matches.
|
@NotNull FilterBuilder |
setChangeSetFilter(@NotNull ChangeSetFilter changeSetFilter) |
@NotNull FilterBuilder.Condition |
universal(@NotNull UniversalFilter.Selector selector,
@NotNull com.google.common.base.Predicate<NodeState> predicate)
A condition that holds when the predicate matches.
|
@NotNull FilterBuilder.Condition |
uuid(@NotNull UniversalFilter.Selector selector,
@Nullable java.lang.String[] uuids)
A condition that holds for matching uuids.
|
@NotNull public @NotNull FilterBuilder setChangeSetFilter(@NotNull @NotNull ChangeSetFilter changeSetFilter)
@NotNull public @NotNull FilterBuilder addSubTree(@NotNull @NotNull java.lang.String absPath)
This is used for optimisation in order to restrict traversal to these sub trees.
absPath
- absolute pathpublic FilterBuilder addPathsForMBean(@NotNull @NotNull java.util.Set<java.lang.String> paths)
paths
- public FilterBuilder aggregator(EventAggregator aggregator)
@NotNull public @NotNull FilterBuilder includeSessionLocal(boolean include)
false
.include
- if true
session local changes are included,
otherwise session local changes are not included.@NotNull public @NotNull FilterBuilder includeClusterExternal(boolean include)
false
.include
- if true
cluster external changes are included,
otherwise cluster external changes are not included.@NotNull public @NotNull FilterBuilder includeClusterLocal(boolean include)
true
.include
- if true
cluster local changes are included,
otherwise cluster local changes are not included.@NotNull public @NotNull FilterBuilder condition(@NotNull @NotNull FilterBuilder.Condition condition)
Condition
instance.condition
- the conditions to apply@NotNull public @NotNull FilterBuilder.Condition includeAll()
@NotNull public @NotNull FilterBuilder.Condition excludeAll()
@NotNull public @NotNull FilterBuilder.Condition accessControl(@NotNull @NotNull PermissionProviderFactory permissionProviderFactory)
permissionProviderFactory
- permission provider for checking whether an item is accessible.ACFilter
@NotNull public @NotNull FilterBuilder.Condition path(@NotNull @NotNull java.lang.String pathPattern)
pathPattern
- GlobbingPathFilter
@NotNull public @NotNull FilterBuilder.Condition eventType(int eventTypes)
eventTypes
- EventTypeFilter
@NotNull public @NotNull FilterBuilder.Condition nodeType(@NotNull @NotNull UniversalFilter.Selector selector, @Nullable @Nullable java.lang.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.@NotNull public @NotNull FilterBuilder.Condition uuid(@NotNull @NotNull UniversalFilter.Selector selector, @Nullable @Nullable java.lang.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.@NotNull public @NotNull FilterBuilder.Condition property(@NotNull @NotNull UniversalFilter.Selector selector, @NotNull @NotNull java.lang.String name, @NotNull @NotNull com.google.common.base.Predicate<PropertyState> 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 property@NotNull public @NotNull FilterBuilder.Condition universal(@NotNull @NotNull UniversalFilter.Selector selector, @NotNull @NotNull com.google.common.base.Predicate<NodeState> predicate)
selector
- selector selecting the node to check the condition onpredicate
- the predicate to check on the selected node@NotNull public @NotNull FilterBuilder.Condition addSubtree()
@NotNull public @NotNull FilterBuilder.Condition deleteSubtree()
@NotNull public @NotNull FilterBuilder.Condition moveSubtree()
@NotNull public @NotNull FilterBuilder.Condition any(@NotNull FilterBuilder.Condition... conditions)
conditions
- conditions of which any must hold in order for this condition to hold@NotNull public @NotNull FilterBuilder.Condition all(@NotNull FilterBuilder.Condition... conditions)
conditions
- conditions of which all must hold in order for this condition to hold@NotNull public @NotNull FilterBuilder.Condition all(@NotNull @NotNull java.util.List<FilterBuilder.Condition> conditions)
conditions
- conditions of which all must hold in order for this condition to hold@NotNull public @NotNull FilterBuilder.Condition not(@NotNull @NotNull FilterBuilder.Condition condition)
condition
- condition which must not hold in order for this condition to hold@NotNull public @NotNull FilterBuilder.Condition any(@NotNull @NotNull java.lang.Iterable<FilterBuilder.Condition> conditions)
conditions
- conditions of which any must hold in order for this condition to hold@NotNull public @NotNull FilterBuilder.Condition all(@NotNull @NotNull java.lang.Iterable<FilterBuilder.Condition> conditions)
conditions
- conditions of which all must hold in order for this condition to hold@NotNull public @NotNull FilterProvider build()
FilterProvider
reflecting the current state of this builder.Copyright © 2010 - 2020 Adobe. All Rights Reserved