Package gda.beamline.health

Enum Class BeamlineHealthState

java.lang.Object

java.lang.Enum<BeamlineHealthState>

gda.beamline.health.BeamlineHealthState

All Implemented Interfaces:

Serializable, Comparable<BeamlineHealthState>, Constable

public enum BeamlineHealthState
extends Enum<BeamlineHealthState>

Used to indicate the overall health state of the beamline and the components that are configured as relevant to the the beamline's status.

• ERROR indicates that the beamline is not in a usable state
• WARNING indicates that the beamline is usable, but some scannables may not be in their ideal state
• NOT_CHECKED is only applicable to individual components and indicates that the condition for that component is disabled and therefore the component's state has not been checked.

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
ERROR
NOT_CHECKED
OK
WARNING

Method Summary

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

ERROR

public static final BeamlineHealthState ERROR

WARNING

public static final BeamlineHealthState WARNING

NOT_CHECKED

public static final BeamlineHealthState NOT_CHECKED

OK

public static final BeamlineHealthState OK

Method Details

values

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