An interface defining life-cycle methods for instances to be served by an {@link ObjectPool}.
By contract, when an {@link ObjectPool} delegates to a{@link PooledObjectFactory},
- {@link #makeObject} is called whenever a new instance is needed.
- {@link #activateObject} is invoked on every instance that has been{@link #passivateObject passivated} before it is{@link ObjectPool#borrowObject borrowed} from the pool.
- {@link #validateObject} may be invoked on {@link #activateObject activated}instances to make sure they can be {@link ObjectPool#borrowObject borrowed}from the pool. {@link #validateObject} may also be used totest an instance being {@link ObjectPool#returnObject returned} to the poolbefore it is {@link #passivateObject passivated}. It will only be invoked on an activated instance.
- {@link #passivateObject} is invoked on every instance when it is returnedto the pool.
- {@link #destroyObject} is invoked on every instance when it is being"dropped" from the pool (whether due to the response from {@link #validateObject}, or for reasons specific to the pool implementation.) There is no guarantee that the instance being destroyed will be considered active, passive or in a generally consistent state.
{@link PooledObjectFactory} must be thread-safe. The only promisean {@link ObjectPool} makes is that the same instance of an object will notbe passed to more than one method of a
PoolableObjectFactory
at a time.
While clients of a {@link KeyedObjectPool} borrow and return instances ofthe underlying value type {@code V}, the factory methods act on instances of {@link PooledObject PooledObject<V>}. These are the object wrappers that pools use to track and maintain state information about the objects that they manage.
@param < T> Type of element managed in this factory.
@see ObjectPool
@version $Revision: 1333925 $
@since 2.0