org.wildfly.clustering.ee

Enum Batch.State

java.lang.Object

java.lang.Enum<Batch.State>

org.wildfly.clustering.ee.Batch.State

All Implemented Interfaces:

Serializable, Comparable<Batch.State>

Enclosing interface:

Batch

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

The possible states of a batch.

Enum Constant Summary

Enum Constants

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

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 Detail

values

public static Batch.State[] 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 (Batch.State c : Batch.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static Batch.State valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null