Enum Class HealthStatus

java.lang.Object

java.lang.Enum<HealthStatus>

com.kingsrook.qqq.middleware.health.model.metadata.HealthStatus

All Implemented Interfaces:

Serializable, Comparable<HealthStatus>, Constable

public enum HealthStatus
extends Enum<HealthStatus>

Enum representing the health status of a component or the overall system. Status meanings: - UP: Component is functioning normally - DOWN: Component is not functioning (critical failure) - DEGRADED: Component is functioning but with reduced capability - UNKNOWN: Component status could not be determined

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
DEGRADED
DOWN
UNKNOWN
UP

Method Summary

Modifier and Type	Method	Description
static HealthStatus	aggregate(HealthStatus... statuses)	Determine the overall status from multiple component statuses.
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

UP

public static final HealthStatus UP

DOWN

public static final HealthStatus DOWN

DEGRADED

public static final HealthStatus DEGRADED

UNKNOWN

public static final HealthStatus UNKNOWN

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

aggregate

public static HealthStatus aggregate(HealthStatus... statuses)

Determine the overall status from multiple component statuses. Rules: - If any component is DOWN, overall is DOWN - If all components are UP, overall is UP - If any component is DEGRADED (and none are DOWN), overall is DEGRADED - If any component is UNKNOWN (and none are DOWN/DEGRADED), overall is UNKNOWN