com.couchbase.client.core.endpoint

Enum DecodingState

java.lang.Object

java.lang.Enum<DecodingState>

com.couchbase.client.core.endpoint.DecodingState

All Implemented Interfaces:

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

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

Describes the states of the decoding process.

This is used internally by the handler implementations to signal their current decoding state. It has impact on which actions need to be performed in each state.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED Decoding is finished.
INITIAL Decoding is not currently taking place.
STARTED Decoding has started and is currently taking place.

Method Summary

Methods

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

INITIAL

public static final DecodingState INITIAL

Decoding is not currently taking place.

STARTED

public static final DecodingState STARTED

Decoding has started and is currently taking place.

FINISHED

public static final DecodingState FINISHED

Decoding is finished.

Method Detail

values

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

Returns:

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

valueOf

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