Package io.vertx.circuitbreaker
Enum CircuitBreakerState
- java.lang.Object
-
- java.lang.Enum<CircuitBreakerState>
-
- io.vertx.circuitbreaker.CircuitBreakerState
-
- All Implemented Interfaces:
Serializable
,Comparable<CircuitBreakerState>
public enum CircuitBreakerState extends Enum<CircuitBreakerState>
Circuit breaker states.- Author:
- Clement Escoffier
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CircuitBreakerState
valueOf(String name)
Returns the enum constant of this type with the specified name.static CircuitBreakerState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
OPEN
public static final CircuitBreakerState OPEN
TheOPEN
state. The circuit breaker is executing the fallback, and switches to theHALF_OPEN
state after the specified time.
-
CLOSED
public static final CircuitBreakerState CLOSED
TheCLOSED
state. The circuit breaker lets invocations pass and collects the failures. If the number of failures reach the specified threshold, the circuit breaker switches to theOPEN
state.
-
HALF_OPEN
public static final CircuitBreakerState HALF_OPEN
TheHALF_OPEN
state. The circuit breaker has been opened, and is now checking the current situation. It lets the next invocation pass and determines from the result (failure or success) if the circuit breaker can be switched to theCLOSED
state again.
-
-
Method Detail
-
values
public static CircuitBreakerState[] 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 (CircuitBreakerState c : CircuitBreakerState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CircuitBreakerState 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 nameNullPointerException
- if the argument is null
-
-