Module io.helidon.faulttolerance

Package io.helidon.faulttolerance

Enum CircuitBreaker.State

java.lang.Object

java.lang.Enum<CircuitBreaker.State>

io.helidon.faulttolerance.CircuitBreaker.State

All Implemented Interfaces:

Serializable, Comparable<CircuitBreaker.State>

Enclosing interface:

CircuitBreaker

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

A circuit breaker can be in any of 3 possible states as defined by this enum. The CLOSED state is the normal one; an OPEN state indicates the circuit breaker is blocking requests and HALF_OPEN that a circuit breaker is transitioning to a CLOSED state provided enough successful requests are observed.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED	Circuit is closed and requests are processed.
HALF_OPEN	Circuit is half open and some test requests are processed, others fail with CircuitBreakerOpenException.
OPEN	Circuit is open and all requests fail with CircuitBreakerOpenException.

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

CLOSED

public static final CircuitBreaker.State CLOSED

Circuit is closed and requests are processed.

HALF_OPEN

public static final CircuitBreaker.State HALF_OPEN

Circuit is half open and some test requests are processed, others fail with CircuitBreakerOpenException.

OPEN

public static final CircuitBreaker.State OPEN

Circuit is open and all requests fail with CircuitBreakerOpenException.

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