com.helger.commons.filter

Interface IFilter<DATATYPE>

Type Parameters:

DATATYPE - The type of object to filter.

All Superinterfaces:

Serializable

All Known Subinterfaces:

IFileFilter

All Known Implementing Classes:

AbstractFileFilter, AbstractFilter, FileFilterDirectoryOnly, FileFilterDirectoryPublic, FileFilterFalse, FileFilterFilenameEndsWith, FileFilterFilenameEquals, FileFilterFilenameEqualsIgnoreCase, FileFilterFilenameHidden, FileFilterFilenameMatchAnyRegEx, FileFilterFilenameMatchNoRegEx, FileFilterFilenameNotEquals, FileFilterFilenameNotEqualsIgnoreCase, FileFilterFilenameStartsWith, FileFilterFileOnly, FileFilterFromFileFilter, FileFilterFromFilenameFilter, FileFilterParentDirectoryPublic, FileFilterTrue, FilterElementWithNamespace, FilterElementWithNamespaceAndLocalName, FilterElementWithoutNamespace, FilterElementWithTagName, FilterFalse, FilterListAll, FilterListAny, FilterNodeIsElement, FilterNot, FilterNotNull, FilterNull, FilterTrue

public interface IFilter<DATATYPE>
extends Serializable

A generic filter interface for simple object selection. If you need an additional parameter for determining whether to filter an object or not, you may use the IFilterWithParameter instead.

Author:

Philip

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matchesFilter(DATATYPE aValue) Check if the given value matches the filter or not.

Method Detail

matchesFilter

@DevelopersNote(value="No @Nullable annotation as we can make no assumptions on the state")
boolean matchesFilter(DATATYPE aValue)

Check if the given value matches the filter or not.

Parameters:

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

Returns:

true if the object match the filter, false otherwise.