Package com.couchbase.client.core.endpoint

Enum EndpointState

java.lang.Object

java.lang.Enum<EndpointState>

com.couchbase.client.core.endpoint.EndpointState

All Implemented Interfaces:

Serializable, Comparable<EndpointState>

public enum EndpointState
extends Enum<EndpointState>

Represents all states an Endpoint can be in.

Since:

2.0.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTED	The endpoint is connected.
CONNECTING	The endpoint is disconnected but trying to connect right now.
DISCONNECTED	The endpoint is disconnected and not trying to connect.
DISCONNECTING	The endpoint is currently disconnecting.

Method Summary

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

DISCONNECTED

public static final EndpointState DISCONNECTED

The endpoint is disconnected and not trying to connect.

CONNECTING

public static final EndpointState CONNECTING

The endpoint is disconnected but trying to connect right now.

CONNECTED

public static final EndpointState CONNECTED

The endpoint is connected.

This is the only state where it can actually try to serve traffic in the expected way.

DISCONNECTING

public static final EndpointState DISCONNECTING

The endpoint is currently disconnecting.

Method Details

values

public static EndpointState[] values()

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

Returns:

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

valueOf

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