Package org.swisspush.gateleen.queue.queuing.circuitbreaker.util

Enum QueueCircuitState

java.lang.Object

java.lang.Enum<QueueCircuitState>

org.swisspush.gateleen.queue.queuing.circuitbreaker.util.QueueCircuitState

All Implemented Interfaces:

Serializable, Comparable<QueueCircuitState>

public enum QueueCircuitState
extends Enum<QueueCircuitState>

Enumeration to represent the status of circuit.

Author:

https://github.com/mcweba [Marc-Andre Weber]

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSED
HALF_OPEN
OPEN

Method Summary

Modifier and Type	Method	Description
static QueueCircuitState	fromString(String state, QueueCircuitState defaultReturnValue)	Returns the enum QueueCircuitState which matches the specified String value.
static QueueCircuitState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static QueueCircuitState[]	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 QueueCircuitState CLOSED

OPEN

public static final QueueCircuitState OPEN

HALF_OPEN

public static final QueueCircuitState HALF_OPEN

Method Detail

values

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

Returns:

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

valueOf

public static QueueCircuitState 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

fromString

public static QueueCircuitState fromString(String state,
                                           QueueCircuitState defaultReturnValue)

Returns the enum QueueCircuitState which matches the specified String value.

Parameters:

state - The state as String

defaultReturnValue - The QueueCircuitState to return when nothing matches (or null was provided)

Returns:

The matching QueueCircuitState or the provided default value if none matches.