com.aquenos.cassandra.pvarchiver.controlsystem

Enum ControlSystemChannelStatus.State

java.lang.Object

java.lang.Enum<ControlSystemChannelStatus.State>

com.aquenos.cassandra.pvarchiver.controlsystem.ControlSystemChannelStatus.State

All Implemented Interfaces:

Serializable, Comparable<ControlSystemChannelStatus.State>

Enclosing class:

ControlSystemChannelStatus

public static enum ControlSystemChannelStatus.State
extends Enum<ControlSystemChannelStatus.State>

State of a control-system channel.

Author:

Sebastian Marsching

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED The channel is connected.
DISABLED Archiving has been temporarily disabled.
DISCONNECTED The channel is disconnected.
ERROR The channel is a permanent error state.

Method Summary

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

CONNECTED

public static final ControlSystemChannelStatus.State CONNECTED

The channel is connected. This means that it is operating normally and is receiving updates with value changes.

DISABLED

public static final ControlSystemChannelStatus.State DISABLED

Archiving has been temporarily disabled. This means that while archiving is enabled in the configuration, the control-system support has decided that no data shall be archived at the moment (most likely due to a dynamic condition not being met).

DISCONNECTED

public static final ControlSystemChannelStatus.State DISCONNECTED

The channel is disconnected. This means that due to a temporary problem (e.g. the corresponding server being stopped), value updates for the channel can currently not be received. However, this situation will recover automatically when the underlying problem has been solved.

ERROR

public static final ControlSystemChannelStatus.State ERROR

The channel is a permanent error state. This means that a permanent problem prevents the channel from operating. For example, an invalid configuration parameter might result in such a problem.

Method Detail

values

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

Returns:

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

valueOf

public static ControlSystemChannelStatus.State 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