Package io.deephaven.engine.table.impl.sources.regioned

Enum Class RegionVisitResult

java.lang.Object

java.lang.Enum<RegionVisitResult>

io.deephaven.engine.table.impl.sources.regioned.RegionVisitResult

All Implemented Interfaces:

Serializable, Comparable<RegionVisitResult>, java.lang.constant.Constable

public enum RegionVisitResult
extends Enum<RegionVisitResult>

Result enum for region-visit patterns.

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
COMPLETE	Returned if the visit operation succeeded for the last region.
CONTINUE	Returned if the visit operation succeeded for the current region
FAILED	Returned if the visit operation failed for the current region.

Method Summary

Modifier and Type	Method	Description
static RegionVisitResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RegionVisitResult[]	values()	Returns an array containing the constants of this enum class, 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

FAILED

public static final RegionVisitResult FAILED

Returned if the visit operation failed for the current region.

CONTINUE

public static final RegionVisitResult CONTINUE

Returned if the visit operation succeeded for the current region

COMPLETE

public static final RegionVisitResult COMPLETE

Returned if the visit operation succeeded for the last region.

Method Details

values

public static RegionVisitResult[] values()

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

Returns:

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

valueOf

public static RegionVisitResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null