com.sh.pool.impl

类 SoftReferenceObjectPool<T>

java.lang.Object

com.sh.pool.BaseObjectPool<T>

com.sh.pool.impl.SoftReferenceObjectPool<T>

所有已实现的接口:

ObjectPool<T>

public class SoftReferenceObjectPool<T>
extends BaseObjectPool<T>
implements ObjectPool<T>

Description: SoftReferenceObjectPool Title:首亨软件 - CRM、TSS、ERP等信息化管理软件

版本:

3.0

作者:

江兴春

构造器概要

构造器

构造器和说明
SoftReferenceObjectPool() 已过时。 to be removed in pool 2.0. Use SoftReferenceObjectPool(PoolableObjectFactory).
SoftReferenceObjectPool(PoolableObjectFactory<T> factory) Create a SoftReferenceObjectPool with the specified factory.
SoftReferenceObjectPool(PoolableObjectFactory<T> factory, int initSize) 已过时。 because this is a SoftReference pool, prefilled idle obejects may be garbage collected before they are used. To be removed in Pool 2.0.

方法概要

限定符和类型	方法和说明
void	addObject() Create an object, and place it into the pool.
T	borrowObject() Borrow an object from the pool.
void	clear() Clears any objects sitting idle in the pool.
void	close() Close this pool, and free any resources associated with it.
PoolableObjectFactory<T>	getFactory() Returns the PoolableObjectFactory used by this pool to create and manage object instances.
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(T obj) Invalidates an object from the pool.
void	returnObject(T obj) Returns an instance to the pool.
void	setFactory(PoolableObjectFactory<T> factory) 已过时。 to be removed in pool 2.0

从类继承的方法 com.sh.pool.BaseObjectPool

isClosed

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

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

构造器详细资料

SoftReferenceObjectPool

@Deprecated
public SoftReferenceObjectPool()

已过时。 to be removed in pool 2.0. Use SoftReferenceObjectPool(PoolableObjectFactory).

Create a 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)

SoftReferenceObjectPool

public SoftReferenceObjectPool(PoolableObjectFactory<T> factory)

Create a SoftReferenceObjectPool with the specified factory.

参数:

factory - object factory to use.

SoftReferenceObjectPool

@Deprecated
public SoftReferenceObjectPool(PoolableObjectFactory<T> factory,
                                            int initSize)
                                     throws java.lang.Exception,
                                            java.lang.IllegalArgumentException

已过时。 because this is a SoftReference pool, prefilled idle obejects may be garbage collected before they are used. To be removed in Pool 2.0.

Create a SoftReferenceObjectPool with the specified factory and initial idle object count.

参数:

factory - object factory to use.

initSize - initial size to attempt to prefill the pool.

抛出:

java.lang.Exception - when there is a problem prefilling the pool.

java.lang.IllegalArgumentException - when factory is null.

方法详细资料

borrowObject

public T borrowObject()
               throws java.lang.Exception

Borrow an object from the pool. If there are no idle instances available in the pool, the configured factory's PoolableObjectFactory.makeObject() method is invoked to create a new instance.

All instances are activated and validated before being returned by this method. If validation fails or an exception occurs activating or validating an idle instance, the failing instance is destroyed and another instance is retrieved from the pool, validated and activated. This process continues until either the pool is empty or an instance passes validation. If the pool is empty on activation or it does not contain any valid instances, the factory's makeObject method is used to create a new instance. If the created instance either raises an exception on activation or fails validation, NoSuchElementException is thrown. Exceptions thrown by MakeObject are propagated to the caller; but other than ThreadDeath or VirtualMachineError, exceptions generated by activation, validation or destroy methods are swallowed silently.

指定者:

borrowObject 在接口中 ObjectPool<T>

指定者:

borrowObject 在类中 BaseObjectPool<T>

返回:

a valid, activated object instance

抛出:

java.util.NoSuchElementException - if a valid object cannot be provided

java.lang.IllegalStateException - if invoked on a closed pool

java.lang.Exception - if an exception occurs creating a new instance

returnObject

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

从类复制的说明: BaseObjectPool

Returns an instance to the pool.

指定者:

returnObject 在接口中 ObjectPool<T>

指定者:

returnObject 在类中 BaseObjectPool<T>

参数:

obj - instance to return to the pool

抛出:

java.lang.Exception

invalidateObject

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

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.

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>

指定者:

invalidateObject 在类中 BaseObjectPool<T>

参数:

obj - a borrowed instance to be disposed.

抛出:

java.lang.Exception - Exception

addObject

public void addObject()
               throws java.lang.Exception

Create an object, and place it into the pool. addObject() is useful for "pre-loading" a pool with idle objects.

Before being added to the pool, the newly created instance is validated and passivated. If validation fails, the new instance is destroyed. Exceptions generated by the factory makeObject or passivate are propagated to the caller. Exceptions destroying instances are silently swallowed.

指定者:

addObject 在接口中 ObjectPool<T>

覆盖:

addObject 在类中 BaseObjectPool<T>

抛出:

java.lang.IllegalStateException - if invoked on a closed pool

java.lang.Exception - when the factory has a problem creating or passivating an object.

getNumIdle

public int getNumIdle()

Returns an approximation not less than the of the number of idle instances in the pool.

指定者:

getNumIdle 在接口中 ObjectPool<T>

覆盖:

getNumIdle 在类中 BaseObjectPool<T>

返回:

estimated number of idle instances in the pool

getNumActive

public int getNumActive()

Return the number of instances currently borrowed from this pool.

指定者:

getNumActive 在接口中 ObjectPool<T>

覆盖:

getNumActive 在类中 BaseObjectPool<T>

返回:

the number of instances currently borrowed from this pool

clear

public void clear()

Clears any objects sitting idle in the pool.

指定者:

clear 在接口中 ObjectPool<T>

覆盖:

clear 在类中 BaseObjectPool<T>

close

public void close()
           throws java.lang.Exception

Close this pool, and free any resources associated with it. Invokes clear() to destroy and remove instances in the pool.

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

指定者:

close 在接口中 ObjectPool<T>

覆盖:

close 在类中 BaseObjectPool<T>

抛出:

java.lang.Exception - never - exceptions clearing the pool are swallowed

setFactory

@Deprecated
public void setFactory(PoolableObjectFactory<T> factory)
                             throws java.lang.IllegalStateException

已过时。 to be removed in pool 2.0

Sets the factory this pool uses to create new instances. Trying to change the factory while there are borrowed objects will throw an IllegalStateException.

指定者:

setFactory 在接口中 ObjectPool<T>

覆盖:

setFactory 在类中 BaseObjectPool<T>

参数:

factory - the PoolableObjectFactory used to create new instances.

抛出:

java.lang.IllegalStateException - when the factory cannot be set at this time

getFactory

public PoolableObjectFactory<T> getFactory()

Returns the PoolableObjectFactory used by this pool to create and manage object instances.

返回:

the factory

从以下版本开始:

1.5.5