org.apache.commons.pool
Class BaseKeyedPoolableObjectFactory

java.lang.Object
  org.apache.commons.pool.BaseKeyedPoolableObjectFactory

All Implemented Interfaces:

KeyedPoolableObjectFactory

public abstract class BaseKeyedPoolableObjectFactory
extends Object
implements KeyedPoolableObjectFactory

A base implementation of KeyedPoolableObjectFactory.

All operations defined here are essentially no-op's.

Since:

Pool 1.0

Version:

$Revision: 777748 $ $Date: 2009-05-22 20:00:44 -0400 (Fri, 22 May 2009) $

Author:

Rodney Waldhoff

See Also:

KeyedPoolableObjectFactory

Constructor Summary

BaseKeyedPoolableObjectFactory()

Method Summary

void	activateObject(Object key, Object obj) No-op.
void	destroyObject(Object key, Object obj) No-op.
abstract Object	makeObject(Object key) Create an instance that can be served by the pool.
void	passivateObject(Object key, Object obj) No-op.
boolean	validateObject(Object key, Object obj) This implementation always returns true.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseKeyedPoolableObjectFactory

public BaseKeyedPoolableObjectFactory()

Method Detail

makeObject

public abstract Object makeObject(Object key)
                           throws Exception

Description copied from interface: KeyedPoolableObjectFactory

Create an instance that can be served by the pool. Instances returned from this method should be in the same state as if they had been activated. They will not be activated before being served by the pool.

Specified by:

makeObject in interface KeyedPoolableObjectFactory

Parameters:

key - the key used when constructing the object

Returns:

an instance that can be served by the pool.

Throws:

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

destroyObject

public void destroyObject(Object key,
                          Object obj)
                   throws Exception

No-op.

Specified by:

destroyObject in interface KeyedPoolableObjectFactory

Parameters:

key - the key used when selecting the instance

obj - the instance to be destroyed

Throws:

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

See Also:

KeyedPoolableObjectFactory.validateObject(java.lang.Object, java.lang.Object), KeyedObjectPool.invalidateObject(java.lang.Object, java.lang.Object)

validateObject

public boolean validateObject(Object key,
                              Object obj)

This implementation always returns true.

Specified by:

validateObject in interface KeyedPoolableObjectFactory

Parameters:

key - the key used when selecting the object

obj - the instance to be validated

Returns:

true

activateObject

public void activateObject(Object key,
                           Object obj)
                    throws Exception

No-op.

Specified by:

activateObject in interface KeyedPoolableObjectFactory

Parameters:

key - the key used when selecting the object

obj - the instance to be activated

Throws:

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

See Also:

KeyedPoolableObjectFactory.destroyObject(java.lang.Object, java.lang.Object)

passivateObject

public void passivateObject(Object key,
                            Object obj)
                     throws Exception

No-op.

Specified by:

passivateObject in interface KeyedPoolableObjectFactory

Parameters:

key - the key used when selecting the object

obj - the instance to be passivated

Throws:

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

See Also:

KeyedPoolableObjectFactory.destroyObject(java.lang.Object, java.lang.Object)