org.apache.commons.pool2

类 BaseObjectPool<T>

java.lang.Object

org.apache.commons.pool2.BaseObject

org.apache.commons.pool2.BaseObjectPool<T>

类型参数:

T - Type of element pooled in this pool.

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, ObjectPool<T>

直接已知子类:

SoftReferenceObjectPool

public abstract class BaseObjectPool<T>
extends BaseObject
implements ObjectPool<T>

A simple base implementation of ObjectPool. Optional operations are implemented to either do nothing, return a value indicating it is unsupported or throw UnsupportedOperationException.

This class is intended to be thread-safe.

从以下版本开始:

2.0

构造器概要

构造器

构造器和说明
BaseObjectPool()

方法概要

限定符和类型	方法和说明
void	addObject() Not supported in this base implementation.
abstract T	borrowObject() Borrows an instance from this pool.
void	clear() Not supported in this base implementation.
void	close() Closes this pool, and free any resources associated with it.
int	getNumActive() Not supported in this base implementation.
int	getNumIdle() Not supported in this base implementation.
abstract void	invalidateObject(T obj) Invalidates an object from the pool.
boolean	isClosed() Has this pool instance been closed.
abstract void	returnObject(T obj) Returns an instance to the pool.

从类继承的方法 org.apache.commons.pool2.BaseObject

toString

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.commons.pool2.ObjectPool

addObjects, invalidateObject

构造器详细资料

BaseObjectPool

public BaseObjectPool()

方法详细资料

addObject

public void addObject()
               throws java.lang.Exception,
                      java.lang.UnsupportedOperationException

Not supported in this base implementation. Subclasses should override this behavior.

指定者:

addObject 在接口中 ObjectPool<T>

抛出:

java.lang.UnsupportedOperationException - if the pool does not implement this method

java.lang.Exception - when PooledObjectFactory.makeObject() fails.

java.lang.IllegalStateException - after ObjectPool.close() has been called on this pool.

borrowObject

public abstract T borrowObject()
                        throws java.lang.Exception

从接口复制的说明: ObjectPool

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 with PooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>) and then validated with PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>).

By contract, clients must return the borrowed instance using ObjectPool.returnObject(T), ObjectPool.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).

指定者:

borrowObject 在接口中 ObjectPool<T>

返回:

an instance from this pool.

抛出:

java.lang.IllegalStateException - after close has 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.

clear

public void clear()
           throws java.lang.Exception,
                  java.lang.UnsupportedOperationException

Not supported in this base implementation.

指定者:

clear 在接口中 ObjectPool<T>

抛出:

java.lang.UnsupportedOperationException - if the pool does not implement this method

java.lang.Exception - if the pool cannot be cleared

close

public void close()

Closes this pool, and free any resources associated with it.

Calling ObjectPool.addObject() or ObjectPool.borrowObject() after invoking this method on a pool will cause them to throw an IllegalStateException.

Implementations should silently fail if not all resources can be freed.

This affects the behavior of isClosed and assertOpen.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

指定者:

close 在接口中 ObjectPool<T>

getNumActive

public int getNumActive()

Not supported in this base implementation.

指定者:

getNumActive 在接口中 ObjectPool<T>

返回:

a negative value.

getNumIdle

public int getNumIdle()

Not supported in this base implementation.

指定者:

getNumIdle 在接口中 ObjectPool<T>

返回:

a negative value.

invalidateObject

public abstract void invalidateObject(T obj)
                               throws java.lang.Exception

从接口复制的说明: ObjectPool

Invalidates an object from the pool.

By contract, obj must have been obtained using ObjectPool.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 在接口中 ObjectPool<T>

参数:

obj - a borrowed instance to be disposed.

抛出:

java.lang.Exception - if the instance cannot be invalidated

isClosed

public final boolean isClosed()

Has this pool instance been closed.

返回:

true when this pool has been closed.

returnObject

public abstract void returnObject(T obj)
                           throws java.lang.Exception

从接口复制的说明: ObjectPool

Returns an instance to the pool. By contract, obj must have been obtained using ObjectPool.borrowObject() or a related method as defined in an implementation or sub-interface.

指定者:

returnObject 在接口中 ObjectPool<T>

参数:

obj - a borrowed instance to be returned.

抛出:

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