Package org.gcube.common.health.api

Enum Class State

java.lang.Object

java.lang.Enum<State>

org.gcube.common.health.api.State

All Implemented Interfaces:

Serializable, Comparable<State>, Constable

public enum State
extends Enum<State>

What a state means, as a figure of kind Figure.STATES declares it for each of its states, so that a page draws each with the colour of its meaning instead of guessing it from its name.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CRITICAL	Something that does not work, or is gone: e.g. a deleted Context.
GOOD	Everything works: e.g. an active Context.
NEUTRAL	Neither good nor bad: e.g. a Context created and not active yet.
WARNING	Something to look at: e.g. a suspended Context.

Method Summary

Modifier and Type	Method	Description
String	value()	Returns the name of the meaning in JSON: good, warning, critical, neutral.
static State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GOOD

public static final State GOOD

Everything works: e.g. an active Context.

WARNING

public static final State WARNING

Something to look at: e.g. a suspended Context.

CRITICAL

public static final State CRITICAL

Something that does not work, or is gone: e.g. a deleted Context.

NEUTRAL

public static final State NEUTRAL

Neither good nor bad: e.g. a Context created and not active yet.

Method Details

values

public static State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Returns the name of the meaning in JSON: good, warning, critical, neutral.

Returns:

the name