Interface ObjectPool<T>
- 
- Type Parameters:
- T- Type of element pooled in this pool.
 - All Superinterfaces:
- java.lang.AutoCloseable,- java.io.Closeable
 - All Known Implementing Classes:
- BaseObjectPool,- GenericObjectPool,- SoftReferenceObjectPool
 
 public interface ObjectPool<T> extends java.io.CloseableA pooling simple interface.Example of use: Object obj = null;try{ obj = pool.borrowObject();try{//...use the object...}catch(Exception e) {// invalidate the objectpool.invalidateObject(obj);// do not return the object to the pool twiceobj =null; }finally{// make sure the object is returned to the poolif(null!= obj) { pool.returnObject(obj); } } }catch(Exception e) {// failed to borrow an object}See BaseObjectPoolfor a simple base implementation.- Since:
- 2.0
- See Also:
- PooledObjectFactory,- KeyedObjectPool,- BaseObjectPool
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voidaddObject()Creates an object using thefactoryor other implementation dependent mechanism, passivate it, and then place it in the idle object pool.default voidaddObjects(int count)CallsaddObject()countnumber of times.TborrowObject()Borrows an instance from this pool.voidclear()Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).voidclose()Closes this pool, and free any resources associated with it.intgetNumActive()Gets the number of instances currently borrowed from this pool.intgetNumIdle()Gets the number of instances currently idle in this pool.voidinvalidateObject(T obj)Invalidates an object from the pool.default voidinvalidateObject(T obj, DestroyMode destroyMode)Invalidates an object from the pool, using the providedDestroyModevoidreturnObject(T obj)Returns an instance to the pool.
 
- 
- 
- 
Method Detail- 
addObjectvoid addObject() throws java.lang.Exception, java.lang.IllegalStateException, java.lang.UnsupportedOperationExceptionCreates an object using thefactoryor other implementation dependent mechanism, passivate it, and then place it in the idle object pool.addObjectis useful for "pre-loading" a pool with idle objects. (Optional operation).- Throws:
- java.lang.Exception- when- PooledObjectFactory.makeObject()fails.
- java.lang.IllegalStateException- after- close()has been called on this pool.
- java.lang.UnsupportedOperationException- when this pool cannot add new idle objects.
 
 - 
addObjectsdefault void addObjects(int count) throws java.lang.ExceptionCallsaddObject()countnumber of times.- Parameters:
- count- the number of idle objects to add.
- Throws:
- java.lang.Exception- when- addObject()fails.
- Since:
- 2.8.0
 
 - 
borrowObjectT borrowObject() throws java.lang.Exception, java.util.NoSuchElementException, java.lang.IllegalStateException Borrows an instance from this pool.Instances returned from this method will have been either newly created with PooledObjectFactory.makeObject()or will be a previously idle object and have been activated withPooledObjectFactory.activateObject(org.apache.tomcat.dbcp.pool2.PooledObject<T>)and then validated withPooledObjectFactory.validateObject(org.apache.tomcat.dbcp.pool2.PooledObject<T>).By contract, clients must return the borrowed instance using returnObject(T),invalidateObject(T), or a related method as defined in an implementation or sub-interface.The behavior of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations). - Returns:
- an instance from this pool.
- Throws:
- java.lang.IllegalStateException- after- closehas been called on this pool.
- java.lang.Exception- when- PooledObjectFactory.makeObject()throws an exception.
- java.util.NoSuchElementException- when the pool is exhausted and cannot or will not return another instance.
 
 - 
clearvoid clear() throws java.lang.Exception, java.lang.UnsupportedOperationExceptionClears any objects sitting idle in the pool, releasing any associated resources (optional operation). Idle objects cleared must bePooledObjectFactory.destroyObject(PooledObject).- Throws:
- java.lang.UnsupportedOperationException- if this implementation does not support the operation
- java.lang.Exception- if the pool cannot be cleared
 
 - 
closevoid close() Closes this pool, and free any resources associated with it.Calling addObject()orborrowObject()after invoking this method on a pool will cause them to throw anIllegalStateException.Implementations should silently fail if not all resources can be freed. - Specified by:
- closein interface- java.lang.AutoCloseable
- Specified by:
- closein interface- java.io.Closeable
 
 - 
getNumActiveint getNumActive() Gets the number of instances currently borrowed from this pool. Returns a negative value if this information is not available.- Returns:
- the number of instances currently borrowed from this pool.
 
 - 
getNumIdleint getNumIdle() Gets the number of instances currently idle in this pool. This may be considered an approximation of the number of objects that can beborrowedwithout creating any new instances. Returns a negative value if this information is not available.- Returns:
- the number of instances currently idle in this pool.
 
 - 
invalidateObjectvoid invalidateObject(T obj) throws java.lang.Exception Invalidates an object from the pool.By contract, objmust have been obtained usingborrowObject()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. - Parameters:
- obj- a- borrowedinstance to be disposed.
- Throws:
- java.lang.Exception- if the instance cannot be invalidated
 
 - 
invalidateObjectdefault void invalidateObject(T obj, DestroyMode destroyMode) throws java.lang.Exception Invalidates an object from the pool, using the providedDestroyModeBy contract, objmust have been obtained usingborrowObject()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. - Parameters:
- obj- a- borrowedinstance to be disposed.
- destroyMode- destroy activation context provided to the factory
- Throws:
- java.lang.Exception- if the instance cannot be invalidated
- Since:
- 2.9.0
 
 - 
returnObjectvoid returnObject(T obj) throws java.lang.Exception Returns an instance to the pool. By contract,objmust have been obtained usingborrowObject()or a related method as defined in an implementation or sub-interface.- Parameters:
- obj- a- borrowedinstance to be returned.
- Throws:
- java.lang.IllegalStateException- if an attempt is made to return an object to the pool that is in any state other than allocated (i.e. borrowed). Attempting to return an object more than once or attempting to return an object that was never borrowed from the pool will trigger this exception.
- java.lang.Exception- if an instance cannot be returned to the pool
 
 
- 
 
-