com.neeve.client
Enum ClientConnectionPool.State

java.lang.Object
  extended by java.lang.Enum<ClientConnectionPool.State>
      extended by com.neeve.client.ClientConnectionPool.State
All Implemented Interfaces:
Serializable, Comparable<ClientConnectionPool.State>
Enclosing class:
ClientConnectionPool

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

Enumerates a connection pool's states.


Enum Constant Summary
CLOSED
          Indicates that the pool has been closed.
FAILED
          Indicates that the pool has failed.
INIT
          Indicates the initialized state.
OPEN
          Indicates that the pool is open and operational.
 
Method Summary
static ClientConnectionPool.State valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ClientConnectionPool.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 ClientConnectionPool.State INIT
Indicates the initialized state. A freshly created pool is initialized with this state.


OPEN

public static final ClientConnectionPool.State OPEN
Indicates that the pool is open and operational. A pool transitions to this state on a successful open.


FAILED

public static final ClientConnectionPool.State FAILED
Indicates that the pool has failed. When a pool transitions to this state is determined by the concrete pool implementation i.e. the pool type.


CLOSED

public static final ClientConnectionPool.State CLOSED
Indicates that the pool has been closed. A client transitions to this state when closed by the user.

Method Detail

values

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


Copyright © 2015 Neeve Research, LLC. All Rights Reserved.