com.couchbase.client.core.message

Enum ResponseStatus

java.lang.Object

java.lang.Enum<ResponseStatus>

com.couchbase.client.core.message.ResponseStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ResponseStatus>

public enum ResponseStatus
extends java.lang.Enum<ResponseStatus>

Typesafe status code returned by CouchbaseResponses.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXISTS If the request expected the document to not exist, but it existed already.
FAILURE Generic failure status.
NOT_EXISTS If the request expected the document to exit, but it didn't exist already.
RETRY The underlying response indicates retry is in order.
SUCCESS If the response is successful and finished.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isSuccess() Check if the current ResponseStatus is success.
static ResponseStatus	valueOf(java.lang.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.

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(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isSuccess

public boolean isSuccess()

Check if the current ResponseStatus is success.