ProgressToken.BucketState (documentapi 7.328.17 API)

java.lang.Object
- java.lang.Enum<ProgressToken.BucketState>
- - com.yahoo.documentapi.ProgressToken.BucketState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProgressToken.BucketState>

Enclosing class:

ProgressToken
```
public static enum ProgressToken.BucketState
extends java.lang.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.

Enum Constant Summary

Enum Constants
Enum Constant Description

BUCKET_ACTIVE

BUCKET_PENDING

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static ProgressToken.BucketState`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static ProgressToken.BucketState[]`	`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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - BUCKET_PENDING
```
public static final ProgressToken.BucketState BUCKET_PENDING
```
  - BUCKET_ACTIVE
```
public static final ProgressToken.BucketState BUCKET_ACTIVE
```
- Method Detail
  - values
```
public static ProgressToken.BucketState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (ProgressToken.BucketState c : ProgressToken.BucketState.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ProgressToken.BucketState valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null