Package org.eso.ias.heartbeat

Enum Class HeartbeatStatus

java.lang.Object

java.lang.Enum<HeartbeatStatus>

org.eso.ias.heartbeat.HeartbeatStatus

All Implemented Interfaces:

Serializable, Comparable<HeartbeatStatus>, Constable

public enum HeartbeatStatus
extends Enum<HeartbeatStatus>

The message sent by the heartbeat reporting the status of the tool.

Author:

acaproni

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
EXITING	The tool is shutting down This message includes releasing of resources, closing of threads etc.
PARTIALLY_RUNNING	The tool is running but not fully operative For example a Supervisor where a DASU does not run due to a failure of the TF of one of the ASCEs.
PAUSED	The tool is paused i.e.
RUNNING	The tool is up and running
STARTING_UP	The tool is starting up.

Method Summary

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

STARTING_UP

public static final HeartbeatStatus STARTING_UP

The tool is starting up. This phase includes the building of the objects, acquiringg of resources, initialization etc.

RUNNING

public static final HeartbeatStatus RUNNING

The tool is up and running

PARTIALLY_RUNNING

public static final HeartbeatStatus PARTIALLY_RUNNING

The tool is running but not fully operative For example a Supervisor where a DASU does not run due to a failure of the TF of one of the ASCEs.

PAUSED

public static final HeartbeatStatus PAUSED

The tool is paused i.e. it does not process inputs neither produces outputs.

EXITING

public static final HeartbeatStatus EXITING

The tool is shutting down This message includes releasing of resources, closing of threads etc.

Method Details

values

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