Package com.couchbase.client.core.service

Enum ServiceState

java.lang.Object

java.lang.Enum<ServiceState>

com.couchbase.client.core.service.ServiceState

All Implemented Interfaces:

Serializable, Comparable<ServiceState>, java.lang.constant.Constable

public enum ServiceState
extends Enum<ServiceState>

Holds all states a Service can be in.

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTED	This Service has all endpoints connected.
CONNECTING	This Service has all endpoints connecting.
DEGRADED	This Service has at least one endpoint connected.
DISCONNECTED	This Service is disconnected (has endpoints and all are disconnected)
DISCONNECTING	This Service has all endpoints disconnecting.
IDLE	This Service is idle (no endpoints attached at all)

Method Summary

Modifier and Type	Method	Description
static ServiceState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ServiceState[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDLE

public static final ServiceState IDLE

This Service is idle (no endpoints attached at all)

DISCONNECTED

public static final ServiceState DISCONNECTED

This Service is disconnected (has endpoints and all are disconnected)

CONNECTING

public static final ServiceState CONNECTING

This Service has all endpoints connecting.

CONNECTED

public static final ServiceState CONNECTED

This Service has all endpoints connected.

DISCONNECTING

public static final ServiceState DISCONNECTING

This Service has all endpoints disconnecting.

DEGRADED

public static final ServiceState DEGRADED

This Service has at least one endpoint connected.

Method Details

values

public static ServiceState[] 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 ServiceState 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