Package com.tnsai.channels.enums

Enum Class ChannelState

java.lang.Object

java.lang.Enum<ChannelState>

com.tnsai.channels.enums.ChannelState

All Implemented Interfaces:

Serializable, Comparable<ChannelState>, Constable

public enum ChannelState
extends Enum<ChannelState>

Lifecycle state of a channel adapter.

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	Temporarily degraded (e.g. rate limited, reconnecting).
FAILED	Failed to start or encountered a fatal error.
REGISTERED	Registered but not yet started.
RUNNING	Running and accepting messages.
STARTING	Currently starting up (connecting to platform).
STOPPED	Stopped and no longer accepting messages.
STOPPING	Shutting down.

Method Summary

Modifier and Type	Method	Description
static ChannelState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChannelState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REGISTERED

public static final ChannelState REGISTERED

Registered but not yet started.

STARTING

public static final ChannelState STARTING

Currently starting up (connecting to platform).

RUNNING

public static final ChannelState RUNNING

Running and accepting messages.

DEGRADED

public static final ChannelState DEGRADED

Temporarily degraded (e.g. rate limited, reconnecting).

STOPPING

public static final ChannelState STOPPING

Shutting down.

STOPPED

public static final ChannelState STOPPED

Stopped and no longer accepting messages.

FAILED

public static final ChannelState FAILED

Failed to start or encountered a fatal error.

Method Details

values

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