Class PoolUtils.ObjectPoolAdaptor<V>

java.lang.Object

org.apache.commons.pool.PoolUtils.ObjectPoolAdaptor<V>

All Implemented Interfaces:

ObjectPool<V>

Enclosing class:

PoolUtils

private static class PoolUtils.ObjectPoolAdaptor<V>
extends Object
implements ObjectPool<V>

Adapts a KeyedObjectPool to make it an ObjectPool by fixing restricting to a fixed key.

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 Object	key	Fixed key
private final KeyedObjectPool<Object,V>	keyedPool	Underlying KeyedObjectPool

Constructor Summary

Constructors

Constructor	Description
ObjectPoolAdaptor(KeyedObjectPool<Object,V> keyedPool, Object key)	Create a new ObjectPoolAdaptor using the provided KeyedObjectPool and fixed key.

Method Summary

Modifier and Type	Method	Description
void	addObject()	Create an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.
V	borrowObject()	Obtains an instance from this pool.
void	clear()	Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).
void	close()	Close this pool, and free any resources associated with it.
int	getNumActive()	Return the number of instances currently borrowed from this pool (optional operation).
int	getNumIdle()	Return the number of instances currently idle in this pool (optional operation).
void	invalidateObject(V obj)	Invalidates an object from the pool.
void	returnObject(V obj)	Return an instance to the pool.
void	setFactory(PoolableObjectFactory<V> factory)	Deprecated. to be removed in version 2.0
String	toString()

Methods inherited from class Object

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

Field Details

key

private final Object key

Fixed key

keyedPool

private final KeyedObjectPool<Object,V> keyedPool

Underlying KeyedObjectPool

Constructor Details

ObjectPoolAdaptor

ObjectPoolAdaptor(KeyedObjectPool<Object,V> keyedPool,
 Object key)
           throws IllegalArgumentException

Create a new ObjectPoolAdaptor using the provided KeyedObjectPool and fixed key.

Parameters:

keyedPool - underlying KeyedObjectPool

key - fixed key

Throws:

IllegalArgumentException - if either of the parameters is null

Method Details

borrowObject

public V borrowObject()
               throws Exception,
NoSuchElementException,
IllegalStateException

Obtains an instance from this pool.

Instances returned from this method will have been either newly created with makeObject or will be a previously idle object and have been activated with activateObject and then validated with validateObject.

By contract, clients must return the borrowed instance using returnObject, invalidateObject, or a related method as defined in an implementation or sub-interface.

The behaviour of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations). Older versions of this method would return null to indicate exhaustion, newer versions are encouraged to throw a NoSuchElementException.

Specified by:

borrowObject in interface ObjectPool<V>

Returns:

an instance from this pool.

Throws:

Exception - when makeObject throws an exception.

NoSuchElementException - when the pool is exhausted and cannot or will not return another instance.

IllegalStateException - after close has been called on this pool.

returnObject

public void returnObject(V obj)

Return an instance to the pool. By contract, obj must have been obtained using borrowObject or a related method as defined in an implementation or sub-interface.

Specified by:

returnObject in interface ObjectPool<V>

Parameters:

obj - a borrowed instance to be returned.

invalidateObject

public void invalidateObject(V obj)

Invalidates an object from the pool.

By contract, obj must have been obtained using borrowObject or a related method as defined in an implementation or sub-interface.

This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.

Specified by:

invalidateObject in interface ObjectPool<V>

Parameters:

obj - a borrowed instance to be disposed.

addObject

public void addObject()
               throws Exception,
IllegalStateException

Create an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool. addObject is useful for "pre-loading" a pool with idle objects. (Optional operation).

Specified by:

addObject in interface ObjectPool<V>

Throws:

Exception - when PoolableObjectFactory.makeObject() fails.

IllegalStateException - after ObjectPool.close() has been called on this pool.

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException

Return the number of instances currently idle in this pool (optional operation). This may be considered an approximation of the number of objects that can be borrowed without creating any new instances. Returns a negative value if this information is not available.

Specified by:

getNumIdle in interface ObjectPool<V>

Returns:

the number of instances currently idle in this pool or a negative value if unsupported

Throws:

UnsupportedOperationException - deprecated: if this implementation does not support the operation

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException

Return the number of instances currently borrowed from this pool (optional operation). Returns a negative value if this information is not available.

Specified by:

getNumActive in interface ObjectPool<V>

Returns:

the number of instances currently borrowed from this pool or a negative value if unsupported

Throws:

UnsupportedOperationException - deprecated: if this implementation does not support the operation

clear

public void clear()
           throws Exception,
UnsupportedOperationException

Clears any objects sitting idle in the pool, releasing any associated resources (optional operation). Idle objects cleared must be destroyed.

Specified by:

clear in interface ObjectPool<V>

Throws:

UnsupportedOperationException - if this implementation does not support the operation

Exception

close

public void close()

Close this pool, and free any resources associated with it.

Calling ObjectPool.addObject() or ObjectPool.borrowObject() after invoking this method on a pool will cause them to throw an IllegalStateException.

Specified by:

close in interface ObjectPool<V>

setFactory

@Deprecated
public void setFactory(PoolableObjectFactory<V> factory)
                throws IllegalStateException,
UnsupportedOperationException

Deprecated.

to be removed in version 2.0

Sets the PoolableObjectFactory for the pool.

Specified by:

setFactory in interface ObjectPool<V>

Parameters:

factory - new PoolableObjectFactory

Throws:

IllegalStateException - when the factory cannot be set at this time

UnsupportedOperationException - if this implementation does not support the operation

toString

public String toString()

Overrides:

toString in class Object