Package org.apache.qpid.protonj2.engine

Enum ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

org.apache.qpid.protonj2.engine.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>

public enum ConnectionState
extends Enum<ConnectionState>

Represents the state of an AMQP Connection. Each Connection provides both a local and remote connection state that independently reflects the state at each end.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Indicates that the targeted end of the Connection (local or remote) is currently open.
CLOSED	Indicates that the targeted end of the Connection (local or remote) has been closed.
IDLE	Indicates that the targeted end of the Connection (local or remote) has not yet been opened.

Method Summary

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

IDLE

public static final ConnectionState IDLE

Indicates that the targeted end of the Connection (local or remote) has not yet been opened.

ACTIVE

public static final ConnectionState ACTIVE

Indicates that the targeted end of the Connection (local or remote) is currently open.

CLOSED

public static final ConnectionState CLOSED

Indicates that the targeted end of the Connection (local or remote) has been closed.

Method Detail

values

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

Returns:

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

valueOf

public static ConnectionState 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