|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.pool.BaseObjectPool
org.apache.commons.pool.impl.SoftReferenceObjectPool
public class SoftReferenceObjectPool
A SoftReference
based
ObjectPool
.
Constructor Summary | |
---|---|
SoftReferenceObjectPool()
Create a SoftReferenceObjectPool without a factory. |
|
SoftReferenceObjectPool(PoolableObjectFactory factory)
Create a SoftReferenceObjectPool with the specified factory. |
Method Summary | |
---|---|
void |
addObject()
Create an object, and place it into the pool. |
java.lang.Object |
borrowObject()
Obtains an instance from this pool. |
void |
clear()
Clears any objects sitting idle in the pool. |
void |
close()
Close this pool. |
int |
getNumActive()
Return the number of instances currently borrowed from this pool. |
int |
getNumIdle()
Returns an approximation not less than the of the number of idle instances in the pool. |
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. |
void |
returnObject(java.lang.Object obj)
Return an instance to the pool. |
void |
setFactory(PoolableObjectFactory factory)
Sets the factory this pool uses
to create new instances. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SoftReferenceObjectPool()
SoftReferenceObjectPool
without a factory.
setFactory
should be called
before any attempts to use the pool are made.
Generally speaking you should prefer the SoftReferenceObjectPool(PoolableObjectFactory)
constructor.
SoftReferenceObjectPool(PoolableObjectFactory)
public SoftReferenceObjectPool(PoolableObjectFactory factory)
SoftReferenceObjectPool
with the specified factory.
factory
- object factory to use.Method Detail |
---|
public void addObject() throws java.lang.Exception
addObject
in interface ObjectPool
addObject
in class BaseObjectPool
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 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
borrowObject
in class BaseObjectPool
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()
clear
in interface ObjectPool
clear
in class BaseObjectPool
public void close() throws java.lang.Exception
BaseObjectPool
isClosed
and assertOpen
.
close
in interface ObjectPool
close
in class BaseObjectPool
java.lang.Exception
- deprecated: implementations should silently fail if not all resources can be freed.public int getNumActive()
getNumActive
in interface ObjectPool
getNumActive
in class BaseObjectPool
public int getNumIdle()
getNumIdle
in interface ObjectPool
getNumIdle
in class BaseObjectPool
public 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
invalidateObject
in class BaseObjectPool
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 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
returnObject
in class BaseObjectPool
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
factory
this pool uses
to create new instances. Trying to change
the factory
while there are borrowed objects will
throw an IllegalStateException
.
setFactory
in interface ObjectPool
setFactory
in class BaseObjectPool
factory
- the PoolableObjectFactory
used to create new instances.
java.lang.IllegalStateException
- when the factory cannot be set at this time
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |