io.github.resilience4j.circuitbreaker.event

Enum CircuitBreakerEvent.Type

java.lang.Object

java.lang.Enum<CircuitBreakerEvent.Type>

io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CircuitBreakerEvent.Type>

Enclosing interface:

CircuitBreakerEvent

public static enum CircuitBreakerEvent.Type
extends java.lang.Enum<CircuitBreakerEvent.Type>

Event types which are created by a CircuitBreaker.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR A CircuitBreakerEvent which informs that an error has been recorded
IGNORED_ERROR A CircuitBreakerEvent which informs that an error has been ignored
NOT_PERMITTED A CircuitBreakerEvent which informs that a call was not permitted because the CircuitBreaker state is OPEN
STATE_TRANSITION A CircuitBreakerEvent which informs the state of the CircuitBreaker has been changed
SUCCESS A CircuitBreakerEvent which informs that a success has been recorded

Method Summary

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

ERROR

public static final CircuitBreakerEvent.Type ERROR

A CircuitBreakerEvent which informs that an error has been recorded

IGNORED_ERROR

public static final CircuitBreakerEvent.Type IGNORED_ERROR

A CircuitBreakerEvent which informs that an error has been ignored

SUCCESS

public static final CircuitBreakerEvent.Type SUCCESS

A CircuitBreakerEvent which informs that a success has been recorded

NOT_PERMITTED

public static final CircuitBreakerEvent.Type NOT_PERMITTED

A CircuitBreakerEvent which informs that a call was not permitted because the CircuitBreaker state is OPEN

STATE_TRANSITION

public static final CircuitBreakerEvent.Type STATE_TRANSITION

A CircuitBreakerEvent which informs the state of the CircuitBreaker has been changed

Method Detail

values

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

Returns:

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

valueOf

public static CircuitBreakerEvent.Type valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null