Package com.helixframework.api.contract.batch

Enum Class BatchStatus

java.lang.Object

java.lang.Enum<BatchStatus>

com.helixframework.api.contract.batch.BatchStatus

All Implemented Interfaces:

Serializable, Comparable<BatchStatus>, Constable

public enum BatchStatus
extends Enum<BatchStatus>

Enumeration representing the status of a batch 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
FAILURE	Failed batch.
PARTIAL_SUCCESS	Partially successful batch.
SUCCESS	Successful batch.

Method Summary

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

SUCCESS

public static final BatchStatus SUCCESS

Successful batch.

FAILURE

public static final BatchStatus FAILURE

Failed batch.

PARTIAL_SUCCESS

public static final BatchStatus PARTIAL_SUCCESS

Partially successful batch.

Method Details

values

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