Apache Commons Pool 2.12.0 · org.apache.commons.pool2.BasePooledObjectFactory

Access	Constructor and Description
public	BasePooledObjectFactory()

Method Summary

Modifier and Type	Method and Description
public void	activateObject(final PooledObject<T> ignored p) Implements org.apache.commons.pool2.PooledObjectFactory.activateObject. No-op.
public abstract T	Returns: an instance to be served by the pool, not null. create() Creates an object instance, to be wrapped in a `PooledObject`.
public void	destroyObject(final PooledObject<T> ignored p) Implements org.apache.commons.pool2.PooledObjectFactory.destroyObject. No-op.
public PooledObject<T>	makeObject() Implements org.apache.commons.pool2.PooledObjectFactory.makeObject. Creates an instance that can be served by the pool and wrap it in a `PooledObject` to be managed by the pool.
public void	passivateObject(final PooledObject<T> ignored p) Implements org.apache.commons.pool2.PooledObjectFactory.passivateObject. No-op.
public boolean	Returns: `true` validateObject(final PooledObject<T> ignored p) Implements org.apache.commons.pool2.PooledObjectFactory.validateObject. Always returns `true`.
public abstract PooledObject<T>	Returns: The provided instance, wrapped by a `PooledObject` wrap(T the instance to wrap, should not be null. obj) Wraps the provided instance with an implementation of `PooledObject`.

Inherited from org.apache.commons.pool2.BaseObject:: toString toStringAppendFields

BasePooledObjectFactory	back to summary
public BasePooledObjectFactory()

Method Detail

activateObject back to summary

activateObject	back to summary
public void activateObject(final PooledObject<T> p) throws Exception Implements org.apache.commons.pool2.PooledObjectFactory.activateObject. No-op. Parameters p:PooledObject<T> ignored Annotations @Override Exceptions Exception: Doc from org.apache.commons.pool2.PooledObjectFactory.activateObject. if there is a problem activating `obj`, this exception may be swallowed by the pool.

public void activateObject(final PooledObject<T> p) throws Exception

Implements org.apache.commons.pool2.PooledObjectFactory.activateObject.

No-op.

Parameters

p:PooledObject<T>: ignored

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.commons.pool2.PooledObjectFactory.activateObject.

if there is a problem activating obj, this exception may be swallowed by the pool.

create back to summary

create	back to summary
public abstract T create() throws Exception Creates an object instance, to be wrapped in a `PooledObject`. This method must support concurrent, multi-threaded invocation. Returns:T an instance to be served by the pool, not null. Exceptions Exception: if there is a problem creating a new instance, this will be propagated to the code requesting an object.

public abstract T create() throws Exception

Creates an object instance, to be wrapped in a PooledObject.

This method must support concurrent, multi-threaded invocation.

Returns:T

an instance to be served by the pool, not null.

Exceptions

Exception:: if there is a problem creating a new instance, this will be propagated to the code requesting an object.

destroyObject	back to summary
public void destroyObject(final PooledObject<T> p) throws Exception Implements org.apache.commons.pool2.PooledObjectFactory.destroyObject. No-op. Parameters p:PooledObject<T> ignored Annotations @Override Exceptions Exception: Doc from org.apache.commons.pool2.PooledObjectFactory.destroyObject. should be avoided as it may be swallowed by the pool implementation.

destroyObject

back to summary

public void destroyObject(final PooledObject<T> p) throws Exception

Implements org.apache.commons.pool2.PooledObjectFactory.destroyObject.

No-op.

Parameters

p:PooledObject<T>: ignored

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.commons.pool2.PooledObjectFactory.destroyObject.

should be avoided as it may be swallowed by the pool implementation.

makeObject back to summary

makeObject	back to summary
public PooledObject<T> makeObject() throws Exception Implements org.apache.commons.pool2.PooledObjectFactory.makeObject. Doc from org.apache.commons.pool2.PooledObjectFactory.makeObject. Creates an instance that can be served by the pool and wrap it in a `PooledObject` to be managed by the pool. Returns:PooledObject<T> a `PooledObject` wrapping an instance that can be served by the pool, not null. Annotations @Override Exceptions Exception: if there is a problem creating a new instance, this will be propagated to the code requesting an object.

public PooledObject<T> makeObject() throws Exception

Implements org.apache.commons.pool2.PooledObjectFactory.makeObject.

Doc from org.apache.commons.pool2.PooledObjectFactory.makeObject.

Creates an instance that can be served by the pool and wrap it in a PooledObject to be managed by the pool.

Returns:PooledObject<T>

a PooledObject wrapping an instance that can be served by the pool, not null.

Annotations

@Override

Exceptions

Exception:: if there is a problem creating a new instance, this will be propagated to the code requesting an object.

passivateObject back to summary

passivateObject	back to summary
public void passivateObject(final PooledObject<T> p) throws Exception Implements org.apache.commons.pool2.PooledObjectFactory.passivateObject. No-op. Parameters p:PooledObject<T> ignored Annotations @Override Exceptions Exception: Doc from org.apache.commons.pool2.PooledObjectFactory.passivateObject. if there is a problem passivating `obj`, this exception may be swallowed by the pool.

public void passivateObject(final PooledObject<T> p) throws Exception

Implements org.apache.commons.pool2.PooledObjectFactory.passivateObject.

No-op.

Parameters

p:PooledObject<T>: ignored

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.commons.pool2.PooledObjectFactory.passivateObject.

if there is a problem passivating obj, this exception may be swallowed by the pool.

validateObject back to summary

validateObject	back to summary
public boolean validateObject(final PooledObject<T> p) Implements org.apache.commons.pool2.PooledObjectFactory.validateObject. Always returns `true`. Parameters p:PooledObject<T> ignored Returns:boolean `true` Annotations @Override

public boolean validateObject(final PooledObject<T> p)

Implements org.apache.commons.pool2.PooledObjectFactory.validateObject.

Always returns true.

Parameters

p:PooledObject<T>: ignored

Returns:boolean

true

Annotations

@Override

wrap back to summary

wrap	back to summary
public abstract PooledObject<T> wrap(T obj) Wraps the provided instance with an implementation of `PooledObject`. Parameters obj:T the instance to wrap, should not be null. Returns:PooledObject<T> The provided instance, wrapped by a `PooledObject`

public abstract PooledObject<T> wrap(T obj)

Wraps the provided instance with an implementation of PooledObject.

Parameters

obj:T: the instance to wrap, should not be null.

Returns:PooledObject<T>

The provided instance, wrapped by a PooledObject

public abstract Class BasePooledObjectFactory<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail