Package com.yahoo.documentapi

Enum Result.ResultType

java.lang.Object

java.lang.Enum<Result.ResultType>

com.yahoo.documentapi.Result.ResultType

All Implemented Interfaces:

Serializable, Comparable<Result.ResultType>

Enclosing class:

Result

public static enum Result.ResultType
extends Enum<Result.ResultType>

The types that a Result can have.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONDITION_NOT_MET_ERROR	Deprecated, for removal: This API element is subject to removal in a future version.
FATAL_ERROR	The request failed, and retrying is pointless.
SUCCESS	The request was successful, no error information is attached.
TRANSIENT_ERROR	The request failed, but may be successful if retried at a later time.

Method Summary

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

SUCCESS

public static final Result.ResultType SUCCESS

The request was successful, no error information is attached.

TRANSIENT_ERROR

public static final Result.ResultType TRANSIENT_ERROR

The request failed, but may be successful if retried at a later time.

FATAL_ERROR

public static final Result.ResultType FATAL_ERROR

The request failed, and retrying is pointless.

CONDITION_NOT_MET_ERROR

@Deprecated(since="7",
            forRemoval=true)
public static final Result.ResultType CONDITION_NOT_MET_ERROR

Deprecated, for removal: This API element is subject to removal in a future version.

Condition specified in operation not met error

Method Detail

values

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

Returns:

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

valueOf

public static Result.ResultType 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