org.pfsw.text

Class StringFilterCollection

java.lang.Object

org.pfsw.text.AStringFilter

org.pfsw.text.StringFilterCollection

All Implemented Interfaces:

IObjectFilter<java.lang.String>, IStringFilter

public class StringFilterCollection
extends AStringFilter

A collection of IStringFilter objects that can be matched against strings according to a defined boolean operator (AND | OR | XOR).

Field Summary

Fields

Modifier and Type	Field and Description
static BooleanOperation	DEFAULT_OPERATION

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

ALL, NONE

Constructor Summary

Constructors

Constructor and Description
StringFilterCollection() Creates a new empty instance with default boolean operation BooleanOperation.OR.
StringFilterCollection(BooleanOperation operation) Creates a new empty instance with specified boolean operation BooleanOperation.OR.
StringFilterCollection(BooleanOperation operation, IStringFilter... filters) Creates a new instance with the specified boolean operation that will be filled with the given filters.
StringFilterCollection(IStringFilter... filters) Creates a new instance with default boolean operation BooleanOperation.OR that will be filled with the given filters.

Method Summary

Modifier and Type	Method and Description
void	addFilters(IStringFilter... filters) Adds all given filters to this collection.
java.util.List<IStringFilter>	asList() Returns a list with all currently held filters.
void	clear()
protected java.util.List<IStringFilter>	getFilterList()
BooleanOperation	getOperation()
boolean	isEmpty()
boolean	matches(java.lang.String aString) Returns true if the given string matches the filter otherwise false.
protected boolean	matchesAllFilters(java.lang.String aString)
protected boolean	matchesAnyFilter(java.lang.String aString)
protected boolean	matchesOneFilter(java.lang.String aString)
void	setOperation(BooleanOperation operation) Set the boolean operation the filter results must combined with.
int	size()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OPERATION

public static final BooleanOperation DEFAULT_OPERATION

Constructor Detail

StringFilterCollection

public StringFilterCollection()

Creates a new empty instance with default boolean operation BooleanOperation.OR.

StringFilterCollection

public StringFilterCollection(BooleanOperation operation)

Creates a new empty instance with specified boolean operation BooleanOperation.OR.

StringFilterCollection

public StringFilterCollection(IStringFilter... filters)

Creates a new instance with default boolean operation BooleanOperation.OR that will be filled with the given filters.

StringFilterCollection

public StringFilterCollection(BooleanOperation operation,
                              IStringFilter... filters)

Creates a new instance with the specified boolean operation that will be filled with the given filters.

Method Detail

matches

public boolean matches(java.lang.String aString)

Description copied from interface: IStringFilter

Returns true if the given string matches the filter otherwise false.

Parameters:

aString - Any string or even null

addFilters

public void addFilters(IStringFilter... filters)

Adds all given filters to this collection.

size

public int size()

isEmpty

public boolean isEmpty()

clear

public void clear()

getOperation

public BooleanOperation getOperation()

setOperation

public void setOperation(BooleanOperation operation)

Set the boolean operation the filter results must combined with.

Parameters:

operation - The operation (must not be null).

Throws:

java.lang.IllegalArgumentException - If the given operation is null.

asList

public java.util.List<IStringFilter> asList()

Returns a list with all currently held filters.

matchesAnyFilter

protected boolean matchesAnyFilter(java.lang.String aString)

matchesAllFilters

protected boolean matchesAllFilters(java.lang.String aString)

matchesOneFilter

protected boolean matchesOneFilter(java.lang.String aString)

getFilterList

protected java.util.List<IStringFilter> getFilterList()