com.aquenos.cassandra.pvarchiver.server.archiving

Enum ChannelStatus.State

java.lang.Object

java.lang.Enum<ChannelStatus.State>

com.aquenos.cassandra.pvarchiver.server.archiving.ChannelStatus.State

All Implemented Interfaces:

Serializable, Comparable<ChannelStatus.State>

Enclosing class:

ChannelStatus

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

State of an archived channel. A channel always starts in the INITIALIZING state and ends in the DESTROYED or ERROR state.

Author:

Sebastian Marsching

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESTROYED The channel has been destroyed.
DISABLED The channel is disabled.
DISCONNECTED The channel is disconnected.
ERROR The channel does not operate correctly.
INITIALIZING The channel has just been created and is still being initialized.
OK The channel is operating normally.

Method Summary

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

INITIALIZING

public static final ChannelStatus.State INITIALIZING

The channel has just been created and is still being initialized.

OK

public static final ChannelStatus.State OK

The channel is operating normally.

DISABLED

public static final ChannelStatus.State DISABLED

The channel is disabled. This can be because it has been disabled in the configuration or because the control-system support chose to disable archiving based on a dynamic condition. In the latter case, the channel might change back to the OK state without user intervention.

DISCONNECTED

public static final ChannelStatus.State DISCONNECTED

The channel is disconnected. This means that there is no error regarding the archiving, but the channel is currently not available in the backing control-system and thus no new samples are being received.

ERROR

public static final ChannelStatus.State ERROR

The channel does not operate correctly. The origin of the error might be in the archiving system itself or in the control-system-specific adapter.

DESTROYED

public static final ChannelStatus.State DESTROYED

The channel has been destroyed. Typically, this only happens when the archiving service is being shut down (e.g. because the server is going offline) or if the channel is being refreshed. In the latter case, the channel should soon change to the INITIALIZING state.

Method Detail

values

public static ChannelStatus.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 (ChannelStatus.State c : ChannelStatus.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 ChannelStatus.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