org.pfsw.tools.cda.base.model.util

Class StringFilterCollection

java.lang.Object

org.pfsw.tools.cda.base.model.util.StringFilterCollection

All Implemented Interfaces:

java.util.function.Predicate<java.lang.String>, org.pfsw.bif.text.IStringFilter, IStringChecker

public class StringFilterCollection
extends java.lang.Object
implements IStringChecker

Holds a collection of StringFilter objects and allows to check if a given string matches any or none of the filters.

Field Summary

Fields inherited from interface org.pfsw.tools.cda.base.model.util.IStringChecker

ALL_MATCHING, NONE_MATCHING

Fields inherited from interface org.pfsw.bif.text.IStringFilter

ALL, NONE

Constructor Summary

Constructors

Constructor and Description
StringFilterCollection() Creates a new empty filter collection.
StringFilterCollection(java.util.Collection<java.lang.String> stringPatterns) Creates a new filter collection initialized with the given collection of string patterns.

Method Summary

Modifier and Type	Method and Description
void	add(StringFilter aFilter) Adds the given filter to the collection of filter patterns, if it is not yet there
void	addAll(java.util.Collection<java.lang.String> stringPatterns) Adds all given string patterns to this filter collection.
boolean	contains(StringFilter aFilter) Returns true if the given filter is contained in this collection.
StringFilterCollection	copy() Returns a copy of the filter collection that contains copies of all the defined string filters.
protected java.util.List<StringFilter>	getExcludeFilterList()
StringFilter	getFilterAt(int index)
StringFilter[]	getFilters() Returns all contained filters.
protected java.util.List<StringFilter>	getFilters(java.util.function.Predicate<? super StringFilter> predicate)
protected java.util.List<StringFilter>	getIncludeFilterList()
protected java.util.List<StringFilter>	getStringFilterList()
boolean	isEmpty()
boolean	isEqual(StringFilterCollection otherFilter) Returns true if the given filter collection contains exactly the same filters as this one.
boolean	matches(java.lang.String aString)
boolean	matchesAny(java.lang.String aString) Returns true, if the given probe matches any of the patterns.
boolean	matchesNone(java.lang.String aString) Returns true, if the given probe matches none of the patterns.
boolean	remove(StringFilter aFilter) Removes the given filter from the collection if it exists
void	reset() Removes all patterns and starts with a new empty collection.
void	setFilterAt(int index, StringFilter filter)
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pfsw.tools.cda.base.model.util.IStringChecker

test

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

StringFilterCollection

public StringFilterCollection()

Creates a new empty filter collection.

StringFilterCollection

public StringFilterCollection(java.util.Collection<java.lang.String> stringPatterns)

Creates a new filter collection initialized with the given collection of string patterns.

Method Detail

matches

public boolean matches(java.lang.String aString)

Specified by:

matches in interface org.pfsw.bif.text.IStringFilter

matchesAny

public boolean matchesAny(java.lang.String aString)

Returns true, if the given probe matches any of the patterns.

Parameters:

aString - The string to match against all patterns.

matchesNone

public boolean matchesNone(java.lang.String aString)

Returns true, if the given probe matches none of the patterns.

Parameters:

aString - The string to check against all patterns.

add

public void add(StringFilter aFilter)

Adds the given filter to the collection of filter patterns, if it is not yet there

Parameters:

aFilter - The pattern to add

addAll

public void addAll(java.util.Collection<java.lang.String> stringPatterns)

Adds all given string patterns to this filter collection.

remove

public boolean remove(StringFilter aFilter)

Removes the given filter from the collection if it exists

contains

public boolean contains(StringFilter aFilter)

Returns true if the given filter is contained in this collection.

getFilters

public StringFilter[] getFilters()

Returns all contained filters.

getFilterAt

public StringFilter getFilterAt(int index)

setFilterAt

public void setFilterAt(int index,
                        StringFilter filter)

reset

public void reset()

Removes all patterns and starts with a new empty collection.

copy

public StringFilterCollection copy()

Returns a copy of the filter collection that contains copies of all the defined string filters.

isEqual

public boolean isEqual(StringFilterCollection otherFilter)

Returns true if the given filter collection contains exactly the same filters as this one.

size

public int size()

isEmpty

public boolean isEmpty()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIncludeFilterList

protected java.util.List<StringFilter> getIncludeFilterList()

getExcludeFilterList

protected java.util.List<StringFilter> getExcludeFilterList()

getFilters

protected java.util.List<StringFilter> getFilters(java.util.function.Predicate<? super StringFilter> predicate)

getStringFilterList

protected java.util.List<StringFilter> getStringFilterList()