org.apache.jackrabbit.vault.fs.api

Interface ItemFilter

All Superinterfaces:

Dumpable, Filter

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 a ItemFilterSet.

Field Summary

Fields

Modifier and Type	Field and Description
static ItemFilter	ALL The "Catch all" item filter.
static ItemFilter	NONE The "Miss all" item filter.

Method Summary

Modifier and Type	Method and Description
boolean	matches(Item item, int depth) Checks if the given item matches this filters criteria.

Methods inherited from interface org.apache.jackrabbit.vault.fs.api.Dumpable

dump

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(Item item,
                int depth)
         throws 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 check

depth - a relative depth.

Returns:

true if this filter matches the criteria; false otherwise.

Throws:

RepositoryException - if an error occurs.