Package com.saxonica.ee.stream.feed

Enum FilteringFeed.FilterResult

java.lang.Object

java.lang.Enum<FilteringFeed.FilterResult>

com.saxonica.ee.stream.feed.FilteringFeed.FilterResult

All Implemented Interfaces:

Serializable, Comparable<FilteringFeed.FilterResult>, java.lang.constant.Constable

Enclosing class:

FilteringFeed

public static enum FilteringFeed.FilterResult
extends Enum<FilteringFeed.FilterResult>

Three possible results of the Filter#matches operation

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONE	Item was not matched and no further items need to be tested, they can be treated as non-matching
MATCHES	Item was matched
SKIP	Item was not matched

Method Summary

Modifier and Type	Method	Description
static FilteringFeed.FilterResult	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FilteringFeed.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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SKIP

public static final FilteringFeed.FilterResult SKIP

Item was not matched

MATCHES

public static final FilteringFeed.FilterResult MATCHES

Item was matched

DONE

public static final FilteringFeed.FilterResult DONE

Item was not matched and no further items need to be tested, they can be treated as non-matching

Method Details

values

public static FilteringFeed.FilterResult[] values()

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

Returns:

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

valueOf

public static FilteringFeed.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