Package com.funnelback.filter.api.filters

Enum PreFilterCheck

java.lang.Object

java.lang.Enum<PreFilterCheck>

com.funnelback.filter.api.filters.PreFilterCheck

All Implemented Interfaces:

Serializable, Comparable<PreFilterCheck>

public enum PreFilterCheck
extends Enum<PreFilterCheck>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTEMPT_FILTER	Returned when the pre filter check decides that an attempt to filter the document should be made.
SKIP_FILTER	Returned when the pre filter check decides that the filter can not filter the given document and so the filter should be skipped.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PreFilterCheck()

Method Summary

Modifier and Type	Method	Description
static PreFilterCheck	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PreFilterCheck[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ATTEMPT_FILTER

public static final PreFilterCheck ATTEMPT_FILTER

Returned when the pre filter check decides that an attempt to filter the document should be made.

SKIP_FILTER

public static final PreFilterCheck SKIP_FILTER

Returned when the pre filter check decides that the filter can not filter the given document and so the filter should be skipped.

Constructor Detail

PreFilterCheck

private PreFilterCheck()

Method Detail

values

public static PreFilterCheck[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PreFilterCheck c : PreFilterCheck.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PreFilterCheck valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null