|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool.BaseObjectPool
public abstract class BaseObjectPool
A simple base implementation of ObjectPool
.
Optional operations are implemented to either do nothing, return a value
indicating it is unsupported or throw UnsupportedOperationException
.
Constructor Summary | |
---|---|
BaseObjectPool()
|
Method Summary | |
---|---|
void |
addObject()
Not supported in this base implementation. |
abstract java.lang.Object |
borrowObject()
Obtains an instance from this pool. |
void |
clear()
Not supported in this base implementation. |
void |
close()
Close this pool. |
int |
getNumActive()
Not supported in this base implementation. |
int |
getNumIdle()
Not supported in this base implementation. |
abstract void |
invalidateObject(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. |
abstract void |
returnObject(java.lang.Object obj)
Return an instance to the pool. |
void |
setFactory(PoolableObjectFactory 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 BaseObjectPool()
Method Detail |
---|
public void addObject() throws java.lang.Exception, java.lang.UnsupportedOperationException
UnsupportedOperationException
,
subclasses should override this behavior.
addObject
in interface ObjectPool
java.lang.Exception
- when PoolableObjectFactory.makeObject()
fails.
java.lang.IllegalStateException
- after ObjectPool.close()
has been called on this pool.
java.lang.UnsupportedOperationException
- when this pool cannot add new idle objects.public abstract java.lang.Object borrowObject() throws java.lang.Exception
ObjectPool
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
.
borrowObject
in interface ObjectPool
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 ObjectPool
java.lang.UnsupportedOperationException
- if this implementation does not support the operation
java.lang.Exception
public void close() throws java.lang.Exception
isClosed
and assertOpen
.
close
in interface ObjectPool
java.lang.Exception
- deprecated: implementations should silently fail if not all resources can be freed.public int getNumActive() throws java.lang.UnsupportedOperationException
getNumActive
in interface ObjectPool
java.lang.UnsupportedOperationException
- deprecated: if this implementation does not support the operationpublic int getNumIdle() throws java.lang.UnsupportedOperationException
getNumIdle
in interface ObjectPool
java.lang.UnsupportedOperationException
- deprecated: if this implementation does not support the operationpublic abstract void invalidateObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
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.
invalidateObject
in interface ObjectPool
obj
- a borrowed
instance to be disposed.
java.lang.Exception
- deprecated: as of Pool 2.0 pool implementations should swallow
exceptions that occur when a poolable object is returned. For future source compatability
implementations of this method should not even declare that they throw any exception.public abstract void returnObject(java.lang.Object obj) throws java.lang.Exception
ObjectPool
obj
must have been obtained
using borrowObject
or a related method as defined in an implementation
or sub-interface.
returnObject
in interface ObjectPool
obj
- a borrowed
instance to be returned.
java.lang.Exception
- deprecated: as of Pool 2.0 pool implementations should swallow
exceptions that occur when a poolable object is returned. For future source compatability
implementations of this method should not even declare that they throw any exception.public void setFactory(PoolableObjectFactory factory) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
UnsupportedOperationException
,
subclasses should override this behavior.
setFactory
in interface ObjectPool
factory
- the PoolableObjectFactory
used to create new instances.
java.lang.IllegalStateException
- when the factory cannot be set at this time
java.lang.UnsupportedOperationException
- if this implementation does not support the operation
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |