org.apache.commons.pool
Class BaseKeyedPoolableObjectFactory

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

All Implemented Interfaces:

KeyedPoolableObjectFactory

public abstract class BaseKeyedPoolableObjectFactory

extends java.lang.Object

implements KeyedPoolableObjectFactory

A base implemenation of KeyedPoolableObjectFactory.

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

Version:

$Revision: 1.7 $ $Date: 2004/02/28 12:16:21 $

Author:

Rodney Waldhoff

See Also:

KeyedPoolableObjectFactory

Constructor Summary

BaseKeyedPoolableObjectFactory()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseKeyedPoolableObjectFactory

public BaseKeyedPoolableObjectFactory()

Method Detail

activateObject

public void activateObject(java.lang.Object key,
                           java.lang.Object obj)
                    throws java.lang.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:

java.lang.Exception

destroyObject

public void destroyObject(java.lang.Object key,
                          java.lang.Object obj)
                   throws java.lang.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:

java.lang.Exception

makeObject

public abstract java.lang.Object makeObject(java.lang.Object key)
                                     throws java.lang.Exception

Description copied from interface: KeyedPoolableObjectFactory

Create an instance that can be 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:

java.lang.Exception

passivateObject

public void passivateObject(java.lang.Object key,
                            java.lang.Object obj)
                     throws java.lang.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:

java.lang.Exception

validateObject

public boolean validateObject(java.lang.Object key,
                              java.lang.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