Class PoolUtils.SynchronizedKeyedObjectPool<K,V>

java.lang.Object
org.apache.commons.pool.PoolUtils.SynchronizedKeyedObjectPool<K,V>
All Implemented Interfaces:
KeyedObjectPool<K,V>
Enclosing class:
PoolUtils
private static class PoolUtils.SynchronizedKeyedObjectPool<K,V> extends Object implements KeyedObjectPool<K,V>
A synchronized (thread-safe) KeyedObjectPool backed by the specified KeyedObjectPool.

Note: This should not be used on pool implementations that already provide proper synchronization such as the pools provided in the Commons Pool library. Wrapping a pool that waits for poolable objects to be returned before allowing another one to be borrowed with another layer of synchronization will cause liveliness issues or a deadlock.

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 KeyedObjectPool<K,V>
    keyedPool
    Underlying object pool
    private final Object
    lock
    Object whose monitor is used to synchronize methods on the wrapped pool.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SynchronizedKeyedObjectPool(KeyedObjectPool<K,V> keyedPool)
    Create a new SynchronizedKeyedObjectPool wrapping the given pool

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addObject(K key)
    Create an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.
    V
    borrowObject(K key)
    Obtains an instance from this pool for the specified key.
    void
    clear()
    Clears the pool, removing all pooled instances (optional operation).
    void
    clear(K key)
    Clears the specified pool, removing all pooled instances corresponding to the given key (optional operation).
    void
    close()
    Close this pool, and free any resources associated with it.
    int
    getNumActive()
    Returns the total number of instances current borrowed from this pool but not yet returned (optional operation).
    int
    getNumActive(K key)
    Returns the number of instances currently borrowed from but not yet returned to the pool corresponding to the given key (optional operation).
    int
    getNumIdle()
    Returns the total number of instances currently idle in this pool (optional operation).
    int
    getNumIdle(K key)
    Returns the number of instances corresponding to the given key currently idle in this pool (optional operation).
    void
    invalidateObject(K key, V obj)
    Invalidates an object from the pool.
    void
    returnObject(K key, V obj)
    Return an instance to the pool.
    void
    setFactory(KeyedPoolableObjectFactory<K,V> factory)
    Deprecated.
    to be removed in pool 2.0
    String
    toString()

    Methods inherited from class Object

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