org.apache.jackrabbit.filevault.maven.packaging.impl

Class FilterSet<E extends Filter>

java.lang.Object

org.apache.jackrabbit.filevault.maven.packaging.impl.FilterSet<E>

Direct Known Subclasses:

PathFilterSet, StringFilterSet

public abstract class FilterSet<E extends Filter>
extends Object

The item filter set holds a set of item filters each attributed as include or exclude filter. The evaluation of the set allows included items and rejects excluded items.

Additionally it contains a "root" path for which the filters are evaluated. if an item has not the node addressed by the root path as ancestor, it is always excluded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterSet.Entry<E extends Filter> Holds a filter entry

Constructor Summary

Constructors

Constructor and Description
FilterSet() Default constructor.
FilterSet(String root) Creates a new item filter set and sets the respective root path

Method Summary

Modifier and Type	Method and Description
FilterSet	addAll(FilterSet<E> set) Adds (replaces) all entries from the given set to this one.
FilterSet	addExclude(E filter) Adds a new item filter as excluded entry.
FilterSet	addInclude(E filter) Adds a new item filter as included entry.
boolean	covers(String path) Checks if the given item is covered by this filter set.
boolean	equals(Object obj)
List<FilterSet.Entry<E>>	getEntries() Returns the list of entries
ImportMode	getImportMode() Returns the import mode that is specified for this filter set.
String	getRoot() Returns the root path
int	hashCode()
boolean	isAncestor(String path) Checks if the given item is an ancestor of the root node.
boolean	isEmpty() Checks if this filter set has any entries defined.
boolean	isSealed() Checks if this filter set is sealed.
FilterSet	seal() Seals this list, i.e.
void	setImportMode(ImportMode mode) Sets the import mode.
void	setRoot(String path) Sets the root path

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterSet

public FilterSet()

Default constructor. initializes the root path to "/"

FilterSet

public FilterSet(String root)

Creates a new item filter set and sets the respective root path

Parameters:

root - path

Method Detail

getRoot

public String getRoot()

Returns the root path

Returns:

root path

setRoot

public void setRoot(String path)

Sets the root path

Parameters:

path - root path

getImportMode

public ImportMode getImportMode()

Returns the import mode that is specified for this filter set. Defaults to ImportMode.REPLACE.

Returns:

the import mode.

setImportMode

public void setImportMode(ImportMode mode)

Sets the import mode.

Parameters:

mode - import mode

seal

public FilterSet seal()

Seals this list, i.e. makes it unmodifiable.

Returns:

this list

isSealed

public boolean isSealed()

Checks if this filter set is sealed.

Returns:

true if sealed.

addAll

public FilterSet addAll(FilterSet<E> set)

Adds (replaces) all entries from the given set to this one.

Parameters:

set - the set of entries

Returns:

this suitable for chaining.

addInclude

public FilterSet addInclude(E filter)

Adds a new item filter as included entry.

Parameters:

filter - the filter

Returns:

this suitable for chaining.

addExclude

public FilterSet addExclude(E filter)

Adds a new item filter as excluded entry.

Parameters:

filter - the filter

Returns:

this suitable for chaining.

getEntries

public List<FilterSet.Entry<E>> getEntries()

Returns the list of entries

Returns:

the list of entries

isEmpty

public boolean isEmpty()

Checks if this filter set has any entries defined.

Returns:

true if empty

covers

public boolean covers(String path)

Checks if the given item is covered by this filter set. I.e. if the node addressed by the root path is an ancestor of the given item.

Parameters:

path - path of the item

Returns:

true if this set covers the given item

isAncestor

public boolean isAncestor(String path)

Checks if the given item is an ancestor of the root node.

Parameters:

path - path of the item to check

Returns:

true if the given item is an ancestor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object