Package org.apache.bookkeeper.mledger

Enum Class ScanOutcome

java.lang.Object

java.lang.Enum<ScanOutcome>

org.apache.bookkeeper.mledger.ScanOutcome

All Implemented Interfaces:

Serializable, Comparable<ScanOutcome>, Constable

public enum ScanOutcome
extends Enum<ScanOutcome>

Outcome of a Scan 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
ABORTED	The scan was aborted by the system (timed out or too many entries...).
COMPLETED	The scan run fully.
USER_INTERRUPTED	The provided user condition aborted the scan.

Method Summary

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

COMPLETED

public static final ScanOutcome COMPLETED

The scan run fully.

ABORTED

public static final ScanOutcome ABORTED

The scan was aborted by the system (timed out or too many entries...).

USER_INTERRUPTED

public static final ScanOutcome USER_INTERRUPTED

The provided user condition aborted the scan.

Method Details

values

public static ScanOutcome[] 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 ScanOutcome 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