org.datanucleus.store.rdbms.datasource.dbcp.pool

Class BaseKeyedObjectPool

java.lang.Object

org.datanucleus.store.rdbms.datasource.dbcp.pool.BaseKeyedObjectPool

All Implemented Interfaces:

KeyedObjectPool

Direct Known Subclasses:

GenericKeyedObjectPool, StackKeyedObjectPool

public abstract class BaseKeyedObjectPool
extends Object
implements KeyedObjectPool

A simple base implementation of KeyedObjectPool. Optional operations are implemented to either do nothing, return a value indicating it is unsupported or throw UnsupportedOperationException.

Since:

Pool 1.0

Version:

$Revision: 965334 $ $Date: 2010-07-18 20:19:55 -0400 (Sun, 18 Jul 2010) $

Author:

Rodney Waldhoff, Sandy McArthur

Constructor Summary

Constructors

Constructor and Description
BaseKeyedObjectPool()

Method Summary

Modifier and Type	Method and Description
void	addObject(Object key)
protected void	assertOpen()
abstract Object	borrowObject(Object key)
void	clear()
void	clear(Object key)
void	close()
int	getNumActive()
int	getNumActive(Object key)
int	getNumIdle()
int	getNumIdle(Object key)
abstract void	invalidateObject(Object key, Object obj)
protected boolean	isClosed()
abstract void	returnObject(Object key, Object obj)
void	setFactory(KeyedPoolableObjectFactory factory)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseKeyedObjectPool

public BaseKeyedObjectPool()

Method Detail

borrowObject

public abstract Object borrowObject(Object key)
                             throws Exception

Specified by:

borrowObject in interface KeyedObjectPool

Throws:

Exception

returnObject

public abstract void returnObject(Object key,
                                  Object obj)
                           throws Exception

Specified by:

returnObject in interface KeyedObjectPool

Throws:

Exception

invalidateObject

public abstract void invalidateObject(Object key,
                                      Object obj)
                               throws Exception

Specified by:

invalidateObject in interface KeyedObjectPool

Throws:

Exception

addObject

public void addObject(Object key)
               throws Exception,
                      UnsupportedOperationException

Specified by:

addObject in interface KeyedObjectPool

Throws:

Exception

UnsupportedOperationException

getNumIdle

public int getNumIdle(Object key)
               throws UnsupportedOperationException

Specified by:

getNumIdle in interface KeyedObjectPool

Throws:

UnsupportedOperationException

getNumActive

public int getNumActive(Object key)
                 throws UnsupportedOperationException

Specified by:

getNumActive in interface KeyedObjectPool

Throws:

UnsupportedOperationException

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException

Specified by:

getNumIdle in interface KeyedObjectPool

Throws:

UnsupportedOperationException

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException

Specified by:

getNumActive in interface KeyedObjectPool

Throws:

UnsupportedOperationException

clear

public void clear()
           throws Exception,
                  UnsupportedOperationException

Specified by:

clear in interface KeyedObjectPool

Throws:

Exception

UnsupportedOperationException

clear

public void clear(Object key)
           throws Exception,
                  UnsupportedOperationException

Specified by:

clear in interface KeyedObjectPool

Throws:

Exception

UnsupportedOperationException

close

public void close()
           throws Exception

Specified by:

close in interface KeyedObjectPool

Throws:

Exception

setFactory

public void setFactory(KeyedPoolableObjectFactory factory)
                throws IllegalStateException,
                       UnsupportedOperationException

Specified by:

setFactory in interface KeyedObjectPool

Throws:

IllegalStateException

UnsupportedOperationException

isClosed

protected final boolean isClosed()

assertOpen

protected final void assertOpen()
                         throws IllegalStateException

Throws:

IllegalStateException