Class PoolUtils.KeyedPoolableObjectFactoryAdaptor<K,V>

java.lang.Object

org.apache.commons.pool.PoolUtils.KeyedPoolableObjectFactoryAdaptor<K,V>

All Implemented Interfaces:

KeyedPoolableObjectFactory<K,V>

Enclosing class:

PoolUtils

private static class PoolUtils.KeyedPoolableObjectFactoryAdaptor<K,V>
extends Object
implements KeyedPoolableObjectFactory<K,V>

Adaptor class that turns a PoolableObjectFactory into a KeyedPoolableObjectFactory by ignoring keys.

Since:

Pool 1.3

Version:

$Revision: 1222670 $ $Date: 2011-12-23 08:18:25 -0500 (Fri, 23 Dec 2011) $

Field Summary

Fields

Modifier and Type	Field	Description
private final PoolableObjectFactory<V>	factory	Underlying PoolableObjectFactory

Constructor Summary

Constructors

Constructor	Description
KeyedPoolableObjectFactoryAdaptor(PoolableObjectFactory<V> factory)	Create a new KeyedPoolableObjectFactoryAdaptor using the given PoolableObjectFactory to manage objects.

Method Summary

Modifier and Type	Method	Description
void	activateObject(K key, V obj)	Activate the object, ignoring the key.
void	destroyObject(K key, V obj)	Destroy the object, ignoring the key.
V	makeObject(K key)	Create a new object instance, ignoring the key
void	passivateObject(K key, V obj)	Passivate the object, ignoring the key.
String	toString()
boolean	validateObject(K key, V obj)	Validate the object, ignoring the key

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

factory

private final PoolableObjectFactory<V> factory

Underlying PoolableObjectFactory

Constructor Details

KeyedPoolableObjectFactoryAdaptor

KeyedPoolableObjectFactoryAdaptor(PoolableObjectFactory<V> factory)
                           throws IllegalArgumentException

Create a new KeyedPoolableObjectFactoryAdaptor using the given PoolableObjectFactory to manage objects.

Parameters:

factory - wrapped PoolableObjectFactory

Throws:

IllegalArgumentException - if the factory is null

Method Details

makeObject

public V makeObject(K key)
             throws Exception

Create a new object instance, ignoring the key

Specified by:

makeObject in interface KeyedPoolableObjectFactory<K,V>

Parameters:

key - ignored

Returns:

newly created object instance

Throws:

Exception - if there is a problem creating a new instance, this will be propagated to the code requesting an object.

destroyObject

public void destroyObject(K key,
 V obj)
                   throws Exception

Destroy the object, ignoring the key.

Specified by:

destroyObject in interface KeyedPoolableObjectFactory<K,V>

Parameters:

key - ignored

obj - instance to destroy

Throws:

Exception - should be avoided as it may be swallowed by the pool implementation.

See Also:

• KeyedPoolableObjectFactory.validateObject(K, V)
• KeyedObjectPool.invalidateObject(K, V)

validateObject

public boolean validateObject(K key,
 V obj)

Validate the object, ignoring the key

Specified by:

validateObject in interface KeyedPoolableObjectFactory<K,V>

Parameters:

key - ignored

obj - object to validate

Returns:

true if validation is successful

activateObject

public void activateObject(K key,
 V obj)
                    throws Exception

Activate the object, ignoring the key.

Specified by:

activateObject in interface KeyedPoolableObjectFactory<K,V>

Parameters:

key - ignored

obj - object to be activated

Throws:

Exception - if there is a problem activating obj, this exception may be swallowed by the pool.

See Also:

• KeyedPoolableObjectFactory.destroyObject(K, V)

passivateObject

public void passivateObject(K key,
 V obj)
                     throws Exception

Passivate the object, ignoring the key.

Specified by:

passivateObject in interface KeyedPoolableObjectFactory<K,V>

Parameters:

key - ignored

obj - object to passivate

Throws:

Exception - if there is a problem passivating obj, this exception may be swallowed by the pool.

See Also:

• KeyedPoolableObjectFactory.destroyObject(K, V)

toString

public String toString()

Overrides:

toString in class Object