Package com.yahoo.documentapi

Enum Class ProgressToken.BucketState

java.lang.Object

java.lang.Enum<ProgressToken.BucketState>

com.yahoo.documentapi.ProgressToken.BucketState

All Implemented Interfaces:

Serializable, Comparable<ProgressToken.BucketState>, Constable

Enclosing class:

ProgressToken

public static enum ProgressToken.BucketState
extends Enum<ProgressToken.BucketState>

Any bucket kept track of by a ProgressToken instance may be in one of two states: pending or active. Pending means that a bucket may be returned by a VisitorIterator, i.e. it is ready for visiting, while active means that a bucket is currently being visited and may thus not be returned from an iterator. Getting a pending bucket via the iterator sets its state to active and updating an active bucket sets its state back to pending again.

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
BUCKET_ACTIVE
BUCKET_PENDING

Method Summary

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

BUCKET_PENDING

public static final ProgressToken.BucketState BUCKET_PENDING

BUCKET_ACTIVE

public static final ProgressToken.BucketState BUCKET_ACTIVE

Method Details

values

public static ProgressToken.BucketState[] 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 ProgressToken.BucketState 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