PoolDescription (GemFire XD Java API Documentation)

java.lang.Object
- hydra.AbstractDescription
- - hydra.PoolDescription

All Implemented Interfaces:

Serializable
```
public class PoolDescription
extends AbstractDescription
implements Serializable
```
Encodes information needed to describe and create a pool as used by clients.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PoolDescription()

Constructors
Constructor and Description
`PoolDescription()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(com.gemstone.gemfire.cache.client.ClientCacheFactory f)` Configures the client cache factory using this pool description.
`void`	`configure(com.gemstone.gemfire.cache.client.PoolFactory f)` Configures the pool factory using this pool description.
`protected static void`	`configure(TestConfig config)` Creates pool descriptions from the pool parameters in the test configuration.
`protected static boolean`	`equals(com.gemstone.gemfire.cache.client.PoolFactory f, com.gemstone.gemfire.cache.client.Pool p)` Returns whether the factory attributes are the same as the pool.
`Integer`	`getMaxConnections()` Returns the max connections.
`Integer`	`getMinConnections()` Returns the min connections.
`String`	`getName()` Returns the logical name of this pool description and actual name of the pool.
`Long`	`getPingInterval()` Returns the ping interval.
`Integer`	`getReadTimeout()` Returns the read timeout.
`Integer`	`getRetryAttempts()` Returns the retry attempts.
`String`	`getServerGroup()` Returns the server group.
`Integer`	`getStatisticInterval()` Returns the statistic interval.
`protected static String`	`poolFactoryToString(String poolName, com.gemstone.gemfire.cache.client.PoolFactory f)` Returns the named pool factory as a string.
`protected static String`	`poolToString(com.gemstone.gemfire.cache.client.Pool p)` Returns the pool as a string.
`void`	`setMaxConnections(Integer i)` Sets the max connections.
`void`	`setMinConnections(Integer i)` Sets the min connections.
`void`	`setPingInterval(Long l)` Sets the ping interval.
`void`	`setRetryAttempts(Integer i)` Sets the retry attempts.
`void`	`setStatisticInterval(Integer v)` Sets the statistic interval.
`SortedMap`	`toSortedMap()` Returns a sorted map of description fields and their values.

Methods inherited from class hydra.AbstractDescription
addProperties, asList, convertPrm, convertPrmDefault, getBooleanFor, getClass, getClassname, getInstance, getIntegerFor, getNonnegativeIntegerFor, getParametersAndDefaults, getPath, getSSLDescription, loadClass, parseMethod, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PoolDescription
```
public PoolDescription()
```
- Method Detail
  - getName
```
public String getName()
```
    Returns the logical name of this pool description and actual name of the pool.
  - getMinConnections
```
public Integer getMinConnections()
```
    Returns the min connections.
  - setMinConnections
```
public void setMinConnections(Integer i)
```
    Sets the min connections.
  - getMaxConnections
```
public Integer getMaxConnections()
```
    Returns the max connections.
  - setMaxConnections
```
public void setMaxConnections(Integer i)
```
    Sets the max connections.
  - getPingInterval
```
public Long getPingInterval()
```
    Returns the ping interval.
  - setPingInterval
```
public void setPingInterval(Long l)
```
    Sets the ping interval.
  - getReadTimeout
```
public Integer getReadTimeout()
```
    Returns the read timeout.
  - getRetryAttempts
```
public Integer getRetryAttempts()
```
    Returns the retry attempts.
  - setRetryAttempts
```
public void setRetryAttempts(Integer i)
```
    Sets the retry attempts.
  - getServerGroup
```
public String getServerGroup()
```
    Returns the server group.
  - getStatisticInterval
```
public Integer getStatisticInterval()
```
    Returns the statistic interval.
  - setStatisticInterval
```
public void setStatisticInterval(Integer v)
```
    Sets the statistic interval.
  - configure
```
public void configure(com.gemstone.gemfire.cache.client.PoolFactory f)
```
    Configures the pool factory using this pool description.
  - configure
```
public void configure(com.gemstone.gemfire.cache.client.ClientCacheFactory f)
```
    Configures the client cache factory using this pool description.
  - poolToString
```
protected static String poolToString(com.gemstone.gemfire.cache.client.Pool p)
```
    Returns the pool as a string. For use only by #poolToString(Pool).
  - poolFactoryToString
```
protected static String poolFactoryToString(String poolName,
                                            com.gemstone.gemfire.cache.client.PoolFactory f)
```
    Returns the named pool factory as a string. For use only by PoolHelper.poolFactoryToString(String, PoolFactory).
  - equals
```
protected static boolean equals(com.gemstone.gemfire.cache.client.PoolFactory f,
                                com.gemstone.gemfire.cache.client.Pool p)
```
    Returns whether the factory attributes are the same as the pool.
  - toSortedMap
```
public SortedMap toSortedMap()
```
    Description copied from class: AbstractDescription
    
    Returns a sorted map of description fields and their values.
    
    Specified by:
    
    toSortedMap in class AbstractDescription
  - configure
```
protected static void configure(TestConfig config)
```
    Creates pool descriptions from the pool parameters in the test configuration.

Class PoolDescription

Constructor Summary

Method Summary

Methods inherited from class hydra.AbstractDescription

Methods inherited from class java.lang.Object

Constructor Detail

PoolDescription

Method Detail

getName

getMinConnections

setMinConnections

getMaxConnections

setMaxConnections

getPingInterval

setPingInterval

getReadTimeout

getRetryAttempts

setRetryAttempts

getServerGroup

getStatisticInterval

setStatisticInterval

configure

configure

poolToString

poolFactoryToString

equals

toSortedMap

configure