com.helger.commons.filter

Class AbstractFilter<DATATYPE>

java.lang.Object

com.helger.commons.filter.AbstractFilter<DATATYPE>

Type Parameters:

DATATYPE - The type of object to filter.

All Implemented Interfaces:

IFilter<DATATYPE>, IPredicate<DATATYPE>, Serializable

Direct Known Subclasses:

AbstractFileFilter, FilterElementWithNamespace, FilterElementWithNamespaceAndLocalName, FilterElementWithoutNamespace, FilterElementWithTagName, FilterFalse, FilterNotNull, FilterNull, FilterTrue

@NotThreadSafe
public abstract class AbstractFilter<DATATYPE>
extends Object
implements IFilter<DATATYPE>, IPredicate<DATATYPE>

An abstract implementation of IFilter that has an optional nested filter.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractFilter() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
EFilterMatchingStrategy	getMatchingStrategy()
IFilter<? super DATATYPE>	getNestedFilter()
int	hashCode()
boolean	matchesFilter(DATATYPE aValue) Check if the given value matches the filter or not.
abstract boolean	matchesThisFilter(DATATYPE aValue) This is the method to be implemented to match this filter.
AbstractFilter<DATATYPE>	setMatchingStrategy(EFilterMatchingStrategy eMatchingStrategy) Set the filter matching strategy.
AbstractFilter<DATATYPE>	setNestedFilter(IFilter<? super DATATYPE> aNestedFilter) Set the nested filter to be invoked if it matches this filter.
boolean	test(DATATYPE aValue) Evaluates this predicate on the given argument.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilter

public AbstractFilter()

Constructor.

Method Detail

getMatchingStrategy

@Nonnull
public final EFilterMatchingStrategy getMatchingStrategy()

Returns:

The filter matching strategy as provided in the constructor. Never null. By default the "match any" strategy is used.

setMatchingStrategy

@Nonnull
public final AbstractFilter<DATATYPE> setMatchingStrategy(@Nonnull
                                                                    EFilterMatchingStrategy eMatchingStrategy)

Set the filter matching strategy.

Parameters:

eMatchingStrategy - The matching strategy to be used. May not be null.

Returns:

this

getNestedFilter

@Nullable
public final IFilter<? super DATATYPE> getNestedFilter()

Returns:

The nested filter as specified in the constructor. May be null.

setNestedFilter

@Nonnull
public final AbstractFilter<DATATYPE> setNestedFilter(@Nullable
                                                                IFilter<? super DATATYPE> aNestedFilter)

Set the nested filter to be invoked if it matches this filter.

Parameters:

aNestedFilter - The nested filter to use. May be null to not have a nested filter-

Returns:

this

matchesThisFilter

public abstract boolean matchesThisFilter(DATATYPE aValue)

This is the method to be implemented to match this filter.

Parameters:

aValue - The value to be matched

Returns:

true if the value matches the filter

test

public final boolean test(DATATYPE aValue)

Description copied from interface: IPredicate

Evaluates this predicate on the given argument.

Specified by:

test in interface IPredicate<DATATYPE>

Parameters:

aValue - the input argument

Returns:

true if the input argument matches the predicate, otherwise false

matchesFilter

public final boolean matchesFilter(DATATYPE aValue)

Description copied from interface: IFilter

Check if the given value matches the filter or not.

Specified by:

matchesFilter in interface IFilter<DATATYPE>

Parameters:

aValue - The object to filter. May be null depending on the implementation.

Returns:

true if the object match the filter, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object