Package uk.gov.gchq.gaffer.rest

Enum SystemStatus.Status

java.lang.Object

java.lang.Enum<SystemStatus.Status>

uk.gov.gchq.gaffer.rest.SystemStatus.Status

All Implemented Interfaces:

Serializable, Comparable<SystemStatus.Status>

Enclosing class:

SystemStatus

public static enum SystemStatus.Status
extends Enum<SystemStatus.Status>

Enumerated type for the Gaffer system status. This enum is compliant with the Spring Boot Actuator.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN
OUT_OF_SERVICE
UNKNOWN
UP

Method Summary

Modifier and Type	Method	Description
String	getCode()
String	getDescription()
String	toString()
static SystemStatus.Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SystemStatus.Status[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UP

public static final SystemStatus.Status UP

DOWN

public static final SystemStatus.Status DOWN

UNKNOWN

public static final SystemStatus.Status UNKNOWN

OUT_OF_SERVICE

public static final SystemStatus.Status OUT_OF_SERVICE

Method Detail

values

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

Returns:

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

valueOf

public static SystemStatus.Status 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

getCode

public String getCode()

getDescription

public String getDescription()

toString

public String toString()

Overrides:

toString in class Enum<SystemStatus.Status>