K - the type of keys in this poolV - the type of objects held in this poolpublic abstract class BaseKeyedObjectPool<K,V> extends Object implements KeyedObjectPool<K,V>
KeyedObjectPool.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException.| Constructor and Description |
|---|
BaseKeyedObjectPool() |
| Modifier and Type | Method and Description |
|---|---|
void |
addObject(K key)
Not supported in this base implementation.
|
protected void |
assertOpen()
Throws an
IllegalStateException when this pool has been closed. |
abstract V |
borrowObject(K key)
Obtains an instance from this pool for the specified
key. |
void |
clear()
Not supported in this base implementation.
|
void |
clear(K key)
Not supported in this base implementation.
|
void |
close()
Close this pool.
|
int |
getNumActive()
Not supported in this base implementation.
|
int |
getNumActive(K key)
Not supported in this base implementation.
|
int |
getNumIdle()
Not supported in this base implementation.
|
int |
getNumIdle(K key)
Not supported in this base implementation.
|
abstract void |
invalidateObject(K key,
V obj)
Invalidates an object from the pool.
|
protected boolean |
isClosed()
Has this pool instance been closed.
|
abstract 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
|
public abstract V borrowObject(K key) throws Exception
key.
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 object using
returnObject, invalidateObject, or a related method
as defined in an implementation or sub-interface,
using a key that is equivalent to the one used to
borrow the instance in the first place.
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.
borrowObject in interface KeyedObjectPool<K,V>key - the key used to obtain the objectIllegalStateException - after close has been called on this poolException - when makeObject throws an exceptionNoSuchElementException - when the pool is exhausted and cannot or will not return another instancepublic abstract void returnObject(K key, V obj) throws Exception
obj must have been obtained
using borrowObject
or a related method as defined in an implementation
or sub-interface
using a key that is equivalent to the one used to
borrow the instance in the first place.returnObject in interface KeyedObjectPool<K,V>key - the key used to obtain the objectobj - a borrowed instance to be returned.Exceptionpublic abstract void invalidateObject(K key, V obj) throws Exception
Invalidates an object from the pool.
By contract, obj must have been obtained
using borrowObject using a key that is
equivalent to the one used to borrow the Object in the first place.
This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.
invalidateObject in interface KeyedObjectPool<K,V>key - the key used to obtain the objectobj - a borrowed instance to be returned.Exceptionpublic void addObject(K key) throws Exception, UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.addObject in interface KeyedObjectPool<K,V>key - ignoredUnsupportedOperationExceptionException - when KeyedPoolableObjectFactory.makeObject(K) fails.IllegalStateException - after KeyedObjectPool.close() has been called on this pool.public int getNumIdle(K key) throws UnsupportedOperationException
getNumIdle in interface KeyedObjectPool<K,V>key - ignoredUnsupportedOperationException - deprecated: when this implementation doesn't support the operationpublic int getNumActive(K key) throws UnsupportedOperationException
getNumActive in interface KeyedObjectPool<K,V>key - ignoredUnsupportedOperationException - deprecated: when this implementation doesn't support the operationpublic int getNumIdle()
throws UnsupportedOperationException
getNumIdle in interface KeyedObjectPool<K,V>UnsupportedOperationException - deprecated: when this implementation doesn't support the operationpublic int getNumActive()
throws UnsupportedOperationException
getNumActive in interface KeyedObjectPool<K,V>UnsupportedOperationException - deprecated: when this implementation doesn't support the operationpublic void clear()
throws Exception,
UnsupportedOperationException
clear in interface KeyedObjectPool<K,V>UnsupportedOperationExceptionExceptionpublic void clear(K key) throws Exception, UnsupportedOperationException
clear in interface KeyedObjectPool<K,V>key - ignoredUnsupportedOperationExceptionExceptionpublic void close()
throws Exception
isClosed and assertOpen.close in interface KeyedObjectPool<K,V>Exception@Deprecated public void setFactory(KeyedPoolableObjectFactory<K,V> factory) throws IllegalStateException, UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.setFactory in interface KeyedObjectPool<K,V>factory - the new KeyedPoolableObjectFactoryIllegalStateException - when the factory cannot be set at this timeUnsupportedOperationException - when this implementation doesn't support the operationprotected final boolean isClosed()
true when this pool has been closed.protected final void assertOpen()
throws IllegalStateException
IllegalStateException when this pool has been closed.IllegalStateException - when this pool has been closed.isClosed()Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.