Package org.wildfly.clustering.cache.batch

Enum Class Batch.State

java.lang.Object

java.lang.Enum<Batch.State>

org.wildfly.clustering.cache.batch.Batch.State

All Implemented Interfaces:

Serializable, Comparable<Batch.State>, Constable

Enclosing interface:

Batch

public static enum Batch.State
extends Enum<Batch.State>

The possible states of a batch.

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
ACTIVE	The initial state of a batch.
CLOSED	The terminal state of a batch.
DISCARDED	Indicates that an active batch was discarded, but not yet closed.

Method Summary

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

ACTIVE

public static final Batch.State ACTIVE

The initial state of a batch. A batch remains active until it is discarded or closed.

DISCARDED

public static final Batch.State DISCARDED

Indicates that an active batch was discarded, but not yet closed. An active batch moves to this state following Batch.discard().

CLOSED

public static final Batch.State CLOSED

The terminal state of a batch. A batch moves to this state following Batch.close().

Method Details

values

public static Batch.State[] 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 Batch.State 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