Package com.yahoo.documentapi

Enum Class Response.Outcome

java.lang.Object

java.lang.Enum<Response.Outcome>

com.yahoo.documentapi.Response.Outcome

All Implemented Interfaces:

Serializable, Comparable<Response.Outcome>, Constable

Enclosing class:

Response

public static enum Response.Outcome
extends Enum<Response.Outcome>

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
CONDITION_FAILED	The operation failed due to an unmet test-and-set condition.
ERROR	The operation failed for some unknown reason.
INSUFFICIENT_STORAGE	The operation failed because the cluster had insufficient storage to accept it.
NOT_FOUND	The operation failed because its target document was not found.
SUCCESS	The operation was a success.
TIMEOUT	The operation timed out before it reached its destination.

Method Summary

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

The operation was a success.

CONDITION_FAILED

public static final Response.Outcome CONDITION_FAILED

The operation failed due to an unmet test-and-set condition.

NOT_FOUND

public static final Response.Outcome NOT_FOUND

The operation failed because its target document was not found.

INSUFFICIENT_STORAGE

public static final Response.Outcome INSUFFICIENT_STORAGE

The operation failed because the cluster had insufficient storage to accept it.

TIMEOUT

public static final Response.Outcome TIMEOUT

The operation timed out before it reached its destination.

ERROR

public static final Response.Outcome ERROR

The operation failed for some unknown reason.

Method Details

values

public static Response.Outcome[] 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 Response.Outcome 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