com.microfocus.zfe.haapi

Enum ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

com.microfocus.zfe.haapi.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>

public enum ConnectionState
extends Enum<ConnectionState>

Represent the different connection states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED The connection is ready.
CONNECTING The connection process is just beginning.
DISCONNECTED The session is disconnected.
DISCONNECTING The connection is being terminated.

Method Summary

Modifier and Type	Method and Description
String	toString()
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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONNECTING

public static final ConnectionState CONNECTING

The connection process is just beginning. This is the status of the connection after connect() is called but before it has completed; it is the status returned before CONNECTED.

CONNECTED

public static final ConnectionState CONNECTED

The connection is ready. This is the status after connect() has completed and the connection has succeeded.

DISCONNECTING

public static final ConnectionState DISCONNECTING

The connection is being terminated. This is the status returned immediately after the disconnect() method is called.

DISCONNECTED

public static final ConnectionState DISCONNECTED

The session is disconnected. This is the status of the connection before connect() is called, and after disconnect() is complete.

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

toString

public String toString()

Overrides:

toString in class Enum<ConnectionState>