Interface ItemFilter
-
- All Known Implementing Classes:
BaseFilter
,DeclaringTypeItemFilter
,DepthItemFilter
,FileFolderNodeFilter
,IsMandatoryFilter
,IsNodeFilter
,NameItemFilter
,NodeTypeItemFilter
,NtFileItemFilter
public interface ItemFilter extends Filter
The item filter is used to include or exclude a set of repository items. It is usually part of aItemFilterSet
.
-
-
Field Summary
Fields Modifier and Type Field Description static ItemFilter
ALL
The "Catch all" item filter.static ItemFilter
NONE
The "Miss all" item filter.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
matches(javax.jcr.Item item, int depth)
Checks if the given item matches this filters criteria.
-
-
-
Field Detail
-
ALL
static final ItemFilter ALL
The "Catch all" item filter.
-
NONE
static final ItemFilter NONE
The "Miss all" item filter.
-
-
Method Detail
-
matches
boolean matches(javax.jcr.Item item, int depth) throws javax.jcr.RepositoryException
Checks if the given item matches this filters criteria. The given depth is relative to some invoker related depth and may not reflect the hierarchical depth of the item in the repository. It up to the implementation how to deal with this value.- Parameters:
item
- the item to checkdepth
- a relative depth.- Returns:
true
if this filter matches the criteria;false
otherwise.- Throws:
javax.jcr.RepositoryException
- if an error occurs.
-
-