|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||
java.lang.Objectorg.apache.commons.pool.BaseKeyedObjectPool
public abstract class BaseKeyedObjectPool
A simple base implementation of KeyedObjectPool.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException.
| Constructor Summary | |
|---|---|
BaseKeyedObjectPool()
|
|
| Method Summary | |
|---|---|
void |
addObject(java.lang.Object key)
Not supported in this base implementation. |
abstract java.lang.Object |
borrowObject(java.lang.Object key)
Obtains an instance from this pool for the specified key. |
void |
clear()
Not supported in this base implementation. |
void |
clear(java.lang.Object key)
Not supported in this base implementation. |
void |
close()
Close this pool. |
int |
getNumActive()
Not supported in this base implementation. |
int |
getNumActive(java.lang.Object key)
Not supported in this base implementation. |
int |
getNumIdle()
Not supported in this base implementation. |
int |
getNumIdle(java.lang.Object key)
Not supported in this base implementation. |
abstract void |
invalidateObject(java.lang.Object key,
java.lang.Object 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
using a key that is equivalent to the one used to
borrow the Object in the first place. |
abstract void |
returnObject(java.lang.Object key,
java.lang.Object obj)
Return an instance to the pool. |
void |
setFactory(KeyedPoolableObjectFactory factory)
Not supported in this base implementation. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BaseKeyedObjectPool()
| Method Detail |
|---|
public void addObject(java.lang.Object key)
throws java.lang.Exception,
java.lang.UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.
addObject in interface KeyedObjectPoolkey - the key a new instance should be added to
java.lang.Exception - when KeyedPoolableObjectFactory.makeObject(java.lang.Object) fails.
java.lang.IllegalStateException - after KeyedObjectPool.close() has been called on this pool.
java.lang.UnsupportedOperationException - when this pool cannot add new idle objects.
public abstract java.lang.Object borrowObject(java.lang.Object key)
throws java.lang.Exception
KeyedObjectPoolkey.
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 KeyedObjectPoolkey - the key used to obtain the object
java.lang.IllegalStateException - after close has been called on this pool
java.lang.Exception - when makeObject throws an exception
java.util.NoSuchElementException - when the pool is exhausted and cannot or will not return another instance
public void clear()
throws java.lang.Exception,
java.lang.UnsupportedOperationException
clear in interface KeyedObjectPooljava.lang.UnsupportedOperationException - when this implementation doesn't support the operation
java.lang.Exception
public void clear(java.lang.Object key)
throws java.lang.Exception,
java.lang.UnsupportedOperationException
clear in interface KeyedObjectPoolkey - the key to clear
java.lang.UnsupportedOperationException - when this implementation doesn't support the operation
java.lang.Exception
public void close()
throws java.lang.Exception
isClosed and assertOpen.
close in interface KeyedObjectPooljava.lang.Exception
public int getNumActive()
throws java.lang.UnsupportedOperationException
getNumActive in interface KeyedObjectPooljava.lang.UnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public int getNumActive(java.lang.Object key)
throws java.lang.UnsupportedOperationException
getNumActive in interface KeyedObjectPoolkey - the key to query
java.lang.UnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public int getNumIdle()
throws java.lang.UnsupportedOperationException
getNumIdle in interface KeyedObjectPooljava.lang.UnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public int getNumIdle(java.lang.Object key)
throws java.lang.UnsupportedOperationException
getNumIdle in interface KeyedObjectPoolkey - the key to query
java.lang.UnsupportedOperationException - deprecated: when this implementation doesn't support the operation
public abstract void invalidateObject(java.lang.Object key,
java.lang.Object obj)
throws java.lang.Exception
KeyedObjectPoolobj 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 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 KeyedObjectPoolkey - the key used to obtain the objectobj - a borrowed instance to be returned.
java.lang.Exception
public abstract void returnObject(java.lang.Object key,
java.lang.Object obj)
throws java.lang.Exception
KeyedObjectPoolobj 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 KeyedObjectPoolkey - the key used to obtain the objectobj - a borrowed instance to be returned.
java.lang.Exception
public void setFactory(KeyedPoolableObjectFactory factory)
throws java.lang.IllegalStateException,
java.lang.UnsupportedOperationException
UnsupportedOperationException,
subclasses should override this behavior.
setFactory in interface KeyedObjectPoolfactory - the KeyedPoolableObjectFactory used to create new instances.
java.lang.IllegalStateException - when the factory cannot be set at this time
java.lang.UnsupportedOperationException - when this implementation doesn't support the operation
|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||