org.jsefa.common.lowlevel.filter

Enum FilterResult

java.lang.Object

java.lang.Enum<FilterResult>

org.jsefa.common.lowlevel.filter.FilterResult

All Implemented Interfaces:

Serializable, Comparable<FilterResult>

public enum FilterResult
extends Enum<FilterResult>

The possible results of filtering a line.

Author:

Norman Lahme-Huetig

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED The line failed the filter, e.
FAILED_BUT_STORE The line failed the filter, e.
PASSED The line passed the filter.

Method Summary

Methods

Modifier and Type	Method and Description
static FilterResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static FilterResult[]	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

PASSED

public static final FilterResult PASSED

The line passed the filter.

FAILED

public static final FilterResult FAILED

The line failed the filter, e. g. should be skipped.

FAILED_BUT_STORE

public static final FilterResult FAILED_BUT_STORE

The line failed the filter, e. g. should be skipped, but should be stored for later retrieval.

Method Detail

values

public static FilterResult[] 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 (FilterResult c : FilterResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static FilterResult 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