Package io.adamantic.quicknote.types

Enum Class ChannelState

java.lang.Object

java.lang.Enum<ChannelState>

io.adamantic.quicknote.types.ChannelState

All Implemented Interfaces:

Serializable, Comparable<ChannelState>, Constable

public enum ChannelState
extends Enum<ChannelState>

Simple representation of the state of a channel

Author:

Domenico Barra - domenico@adamantic.io

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
CLOSED	The channel is closed, it cannot transport data.
ERROR	The channel is in an error state, it cannot transport data until some remediation action is taken (e.g.
OPEN	The channel is open, it can be used to communicate.

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

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

CLOSED

public static final ChannelState CLOSED

The channel is closed, it cannot transport data.

OPEN

public static final ChannelState OPEN

The channel is open, it can be used to communicate.

ERROR

public static final ChannelState ERROR

The channel is in an error state, it cannot transport data until some remediation action is taken (e.g. closing and reopening, or other repair actions).

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