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>

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

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

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractFilter()
AbstractFilter(IFilter<DATATYPE> aCustomFilter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
IFilter<DATATYPE>	getNestedFilter()
int	hashCode()
boolean	matchesFilter(DATATYPE aValue) Check if the given value matches the filter or not.
protected abstract boolean	matchesThisFilter(DATATYPE aValue) This is the method to be implemented to match this filter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilter

public AbstractFilter()

AbstractFilter

public AbstractFilter(@Nullable
              IFilter<DATATYPE> aCustomFilter)

Method Detail

matchesThisFilter

protected 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

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.

getNestedFilter

@Nullable
public IFilter<DATATYPE> getNestedFilter()

Returns:

The nested filter. May be null.

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