org.thales.punch.platform.api.es.health

Enum HealthLevel.EnumHealth

java.lang.Object

java.lang.Enum<HealthLevel.EnumHealth>

org.thales.punch.platform.api.es.health.HealthLevel.EnumHealth

All Implemented Interfaces:

Serializable, Comparable<HealthLevel.EnumHealth>

Enclosing class:

HealthLevel

public static enum HealthLevel.EnumHealth
extends Enum<HealthLevel.EnumHealth>

Enum Constant Summary

Enum Constants

Enum Constant and Description
GREEN The greater the code, the worst it is (except the 'unknown' special case).
RED
UNKNOWN
YELLOW

Method Summary

Modifier and Type	Method and Description
int	getCode() The code associated to the health status are UNKNOWN(3), RED(2), YELLOW(1), GREEN(0), HEALTH_NOT_APPLICABLE(-1).
String	getLabel()
boolean	isNonNominal()
static HealthLevel.EnumHealth	valueOf(String name) Returns the enum constant of this type with the specified name.
static HealthLevel.EnumHealth[]	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

GREEN

public static final HealthLevel.EnumHealth GREEN

The greater the code, the worst it is (except the 'unknown' special case).

YELLOW

public static final HealthLevel.EnumHealth YELLOW

RED

public static final HealthLevel.EnumHealth RED

UNKNOWN

public static final HealthLevel.EnumHealth UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static HealthLevel.EnumHealth 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 int getCode()

The code associated to the health status are UNKNOWN(3), RED(2), YELLOW(1), GREEN(0), HEALTH_NOT_APPLICABLE(-1). Remember the greater the code, the worst status it represents.

Returns:

the health code value

getLabel

public String getLabel()

Returns:

the human-friendly lowercase text respresentation of the health level.

isNonNominal

public boolean isNonNominal()

Returns:

true if health status is applicable and is not nominal. Remember that unknown health status (when applicable) is worst possible health status, therefore non nominal.