Package com.github.cafapi.common.api

Enum Class HealthStatus

java.lang.Object

java.lang.Enum<HealthStatus>

com.github.cafapi.common.api.HealthStatus

All Implemented Interfaces:

Serializable, Comparable<HealthStatus>, Constable

public enum HealthStatus
extends Enum<HealthStatus>

The overall, concise status of the health of a service.

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
HEALTHY	The service is healthy and operating normally.
UNHEALTHY	The service is unhealthy or failed in some manner.
UNKNOWN	The health could not be determined at this time.

Method Summary

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

UNKNOWN

public static final HealthStatus UNKNOWN

The health could not be determined at this time.

HEALTHY

public static final HealthStatus HEALTHY

The service is healthy and operating normally.

UNHEALTHY

public static final HealthStatus UNHEALTHY

The service is unhealthy or failed in some manner.

Method Details

values

public static HealthStatus[] 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 HealthStatus 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