org.apache.commons.pool2.proxy

类 ProxiedObjectPool<T>

java.lang.Object

org.apache.commons.pool2.proxy.ProxiedObjectPool<T>

类型参数:

T - type of the pooled object

所有已实现的接口:

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

public class ProxiedObjectPool<T>
extends java.lang.Object
implements ObjectPool<T>

Create a new object pool where the pooled objects are wrapped in proxies allowing better control of pooled objects and in particular the prevention of the continued use of an object by a client after that client returns the object to the pool.

从以下版本开始:

2.0

构造器概要

构造器

构造器和说明
ProxiedObjectPool(ObjectPool<T> pool, org.apache.commons.pool2.proxy.ProxySource<T> proxySource) Create a new proxied object pool.

方法概要

限定符和类型	方法和说明
void	addObject() Creates an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.
T	borrowObject() Borrows an instance from this pool.
void	clear() Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).
void	close() Closes this pool, and free any resources associated with it.
int	getNumActive() Gets the number of instances currently borrowed from this pool.
int	getNumIdle() Gets the number of instances currently idle in this pool.
void	invalidateObject(T proxy) Invalidates an object from the pool.
void	returnObject(T proxy) Returns an instance to the pool.
java.lang.String	toString()

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

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

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

addObjects, invalidateObject

构造器详细资料

ProxiedObjectPool

public ProxiedObjectPool(ObjectPool<T> pool,
                         org.apache.commons.pool2.proxy.ProxySource<T> proxySource)

Create a new proxied object pool.

参数:

pool - The object pool to wrap

proxySource - The source of the proxy objects

方法详细资料

addObject

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

从接口复制的说明: ObjectPool

Creates an object using the factory or other implementation dependent mechanism, passivate it, and then place it in the idle object pool. addObject is useful for "pre-loading" a pool with idle objects. (Optional operation).

指定者:

addObject 在接口中 ObjectPool<T>

抛出:

java.lang.Exception - when PooledObjectFactory.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.

borrowObject

public T borrowObject()
               throws java.lang.Exception,
                      java.util.NoSuchElementException,
                      java.lang.IllegalStateException

从接口复制的说明: 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

从接口复制的说明: ObjectPool

Clears any objects sitting idle in the pool, releasing any associated resources (optional operation). Idle objects cleared must be PooledObjectFactory.destroyObject(PooledObject).

指定者:

clear 在接口中 ObjectPool<T>

抛出:

java.lang.UnsupportedOperationException - if this implementation does not support the operation

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

close

public void close()

从接口复制的说明: ObjectPool

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.

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

指定者:

close 在接口中 ObjectPool<T>

getNumActive

public int getNumActive()

从接口复制的说明: ObjectPool

Gets the number of instances currently borrowed from this pool. Returns a negative value if this information is not available.

指定者:

getNumActive 在接口中 ObjectPool<T>

返回:

the number of instances currently borrowed from this pool.

getNumIdle

public int getNumIdle()

从接口复制的说明: ObjectPool

Gets the number of instances currently idle in this pool. This may be considered an approximation of the number of objects that can be borrowed without creating any new instances. Returns a negative value if this information is not available.

指定者:

getNumIdle 在接口中 ObjectPool<T>

返回:

the number of instances currently idle in this pool.

invalidateObject

public void invalidateObject(T proxy)
                      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>

参数:

proxy - a borrowed instance to be disposed.

抛出:

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

returnObject

public void returnObject(T proxy)
                  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>

参数:

proxy - 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

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

从以下版本开始:

2.4.3