com.neeve.client
Enum Client.State

java.lang.Object
  java.lang.Enum<Client.State>
      com.neeve.client.Client.State

All Implemented Interfaces:

Serializable, Comparable<Client.State>

Enclosing class:

Client<T extends ClientConnectionPool>

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

Enumerates a client's states.

Enum Constant Summary

CLOSED
Indicates that a client has been closed.

FAILED
Indicates that a client has failed.

INIT
Indicates the initialized state.

OPEN
Indicates that a client is open and operational.

Method Summary

static Client.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Client.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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INIT

public static final Client.State INIT

Indicates the initialized state. A freshly created client is initialized with this state.

OPEN

public static final Client.State OPEN

Indicates that a client is open and operational. A client transitions to this state when the connection pool is opened.

FAILED

public static final Client.State FAILED

Indicates that a client has failed. A client transitions to this state when the connection pool reports failure.

CLOSED

public static final Client.State CLOSED

Indicates that a client has been closed. A client transitions to this state when closed by the user.

Method Detail

values

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