org.archive.wayback.util
Interface ObjectFilter<E>

Type Parameters:

E -

All Known Implementing Classes:

BeanShellFilter, ClosestResultTrackingFilter, CompositeExclusionFilter, ConditionalGetAnnotationFilter, CounterFilter, DateRangeFilter, DuplicateRecordFilter, EndDateFilter, ExclusionFilter, FilePrefixFilter, FileRegexFilter, GuardRailFilter, HostMatchFilter, HttpCodeFilter, MimeTypeFilter, ObjectFilterChain, OracleAnnotationFilter, OracleExclusionFilter, RemoteExclusionFilter, RobotExclusionFilter, SchemeMatchFilter, SelfRedirectFilter, StartDateFilter, StaticMapExclusionFilter, UrlMatchFilter, UrlPrefixMatchFilter, UserInfoInAuthorityFilter, WARCRevisitAnnotationFilter, WindowEndFilter, WindowStartFilter

public interface ObjectFilter<E>

Interface for including, excluding, or aborting filtering

Version:

$Date: 2010-09-29 05:28:38 +0700 (Wed, 29 Sep 2010) $, $Revision: 3262 $

Author:

brad

Field Summary

static int	FILTER_ABORT constant indicating record should be ommitted, and no more records should be processed.
static int	FILTER_EXCLUDE constant indicating record should be omitted from the result set
static int	FILTER_INCLUDE constant indicating record should be included in the result set

Method Summary

int	filterObject(E o) inpect record and determine if it should be included in the results or not, or if processing of new records should stop.

Field Detail

FILTER_INCLUDE

static final int FILTER_INCLUDE

constant indicating record should be included in the result set

See Also:

Constant Field Values

FILTER_EXCLUDE

static final int FILTER_EXCLUDE

constant indicating record should be omitted from the result set

See Also:

Constant Field Values

FILTER_ABORT

static final int FILTER_ABORT

constant indicating record should be ommitted, and no more records should be processed.

See Also:

Constant Field Values

Method Detail

filterObject

int filterObject(E o)

inpect record and determine if it should be included in the results or not, or if processing of new records should stop.

Parameters:

o - Object which should be checked for inclusion/exclusion or abort

Returns:

int of FILTER_INCLUDE, FILTER_EXCLUDE, or FILTER_ABORT