com.couchbase.client.core.message

Enum ResponseStatus

java.lang.Object

java.lang.Enum<ResponseStatus>

com.couchbase.client.core.message.ResponseStatus

All Implemented Interfaces:

Serializable, Comparable<ResponseStatus>

public enum ResponseStatus
extends Enum<ResponseStatus>

Typesafe status code returned by CouchbaseResponses.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMAND_UNAVAILABLE Indicates that the request type was dispatched but not known by the server or it is not supported.
EXISTS If the request expected the document to not exist, but it existed already.
FAILURE Generic failure status.
INTERNAL_ERROR The remote service failed for an internal reason.
INVALID_ARGUMENTS The service reported that the request arguments are invalid.
NOT_EXISTS If the request expected the document to exit, but it didn't exist already.
NOT_STORED The response indicates that a mutation try did not happen properly.
OUT_OF_MEMORY The requested service is currently out of memory.
RETRY The underlying response indicates retry is in order.
SERVER_BUSY Indicates that the server is busy, which is considered to be transient.
SUCCESS If the response is successful and finished.
TEMPORARY_FAILURE Indicates a failure which is considered to be transient.
TOO_BIG The response indicates that the request was too big for some reason.

Method Summary

Modifier and Type	Method and Description
boolean	isSuccess() Check if the current ResponseStatus is success.
static ResponseStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResponseStatus[]	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 ResponseStatus SUCCESS

If the response is successful and finished.

EXISTS

public static final ResponseStatus EXISTS

If the request expected the document to not exist, but it existed already.

NOT_EXISTS

public static final ResponseStatus NOT_EXISTS

If the request expected the document to exit, but it didn't exist already.

NOT_STORED

public static final ResponseStatus NOT_STORED

The response indicates that a mutation try did not happen properly.

TOO_BIG

public static final ResponseStatus TOO_BIG

The response indicates that the request was too big for some reason.

TEMPORARY_FAILURE

public static final ResponseStatus TEMPORARY_FAILURE

Indicates a failure which is considered to be transient.

SERVER_BUSY

public static final ResponseStatus SERVER_BUSY

Indicates that the server is busy, which is considered to be transient.

COMMAND_UNAVAILABLE

public static final ResponseStatus COMMAND_UNAVAILABLE

Indicates that the request type was dispatched but not known by the server or it is not supported.

OUT_OF_MEMORY

public static final ResponseStatus OUT_OF_MEMORY

The requested service is currently out of memory.

INVALID_ARGUMENTS

public static final ResponseStatus INVALID_ARGUMENTS

The service reported that the request arguments are invalid.

INTERNAL_ERROR

public static final ResponseStatus INTERNAL_ERROR

The remote service failed for an internal reason.

FAILURE

public static final ResponseStatus FAILURE

Generic failure status.

RETRY

public static final ResponseStatus RETRY

The underlying response indicates retry is in order. This is a internal response and should not bubble up to the user level.

Method Detail

values

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

Returns:

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

valueOf

public static ResponseStatus 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

isSuccess

public boolean isSuccess()

Check if the current ResponseStatus is success.