Package io.delta.kernel.utils

Enum CloseableIterator.BreakableFilterResult

Object

Enum<CloseableIterator.BreakableFilterResult>

io.delta.kernel.utils.CloseableIterator.BreakableFilterResult

All Implemented Interfaces:

Serializable, Comparable<CloseableIterator.BreakableFilterResult>

Enclosing interface:

CloseableIterator<T>

public static enum CloseableIterator.BreakableFilterResult
extends Enum<CloseableIterator.BreakableFilterResult>

Represents the result of applying the filter condition in the CloseableIterator.breakableFilter(Function) method of a CloseableIterator. This enum determines how each element in the iterator should be handled.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BREAK	Indicates that the iteration should stop immediately and that no further elements should be processed by CloseableIterator.breakableFilter(Function).
EXCLUDE	Indicates that the current element should be excluded from the resulting iterator produced by CloseableIterator.breakableFilter(Function).
INCLUDE	Indicates that the current element should be included in the resulting iterator produced by CloseableIterator.breakableFilter(Function).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INCLUDE

public static final CloseableIterator.BreakableFilterResult INCLUDE

Indicates that the current element should be included in the resulting iterator produced by CloseableIterator.breakableFilter(Function).

EXCLUDE

public static final CloseableIterator.BreakableFilterResult EXCLUDE

Indicates that the current element should be excluded from the resulting iterator produced by CloseableIterator.breakableFilter(Function).

BREAK

public static final CloseableIterator.BreakableFilterResult BREAK

Indicates that the iteration should stop immediately and that no further elements should be processed by CloseableIterator.breakableFilter(Function).

Method Details

values

public static CloseableIterator.BreakableFilterResult[] 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 CloseableIterator.BreakableFilterResult 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