Package com.couchbase.client.core.endpoint

Enum CircuitBreaker.State

java.lang.Object

java.lang.Enum<CircuitBreaker.State>

com.couchbase.client.core.endpoint.CircuitBreaker.State

All Implemented Interfaces:

Serializable, Comparable<CircuitBreaker.State>

Enclosing interface:

CircuitBreaker

public static enum CircuitBreaker.State
extends Enum<CircuitBreaker.State>

Represents all the states a circuit breaker can be in, possibly.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	The circuit breaker is tracking and closed.
DISABLED	The circuit breaker is disabled.
HALF_OPEN	The circuit breaker is half-open (likely a canary is in-flight).
OPEN	The circuit breaker is open because it has tripped.

Method Summary

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

DISABLED

public static final CircuitBreaker.State DISABLED

The circuit breaker is disabled.

CLOSED

public static final CircuitBreaker.State CLOSED

The circuit breaker is tracking and closed.

HALF_OPEN

public static final CircuitBreaker.State HALF_OPEN

The circuit breaker is half-open (likely a canary is in-flight).

OPEN

public static final CircuitBreaker.State OPEN

The circuit breaker is open because it has tripped.

Method Detail

values

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

Returns:

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

valueOf

public static CircuitBreaker.State 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