org.apache.xindice.util
Interface Poolable

All Known Implementing Classes:

URIMapper

public interface Poolable

Poolable is an interface that must be implemented by Objects that are capable of being managed in a pooled fashion by Xindice.

Version:

$Revision: 511426 $, $Date: 2007-02-24 22:25:02 -0500 (Sat, 24 Feb 2007) $

See Also:

ObjectPool

Method Summary

void	reclaim() reclaim prompts the Poolable object to return itself to the ObjectPool.
void	setPool(ObjectPool pool) setPool passes a reference to the originating ObjectPool for this Object.

Method Detail

setPool

public void setPool(ObjectPool pool)

setPool passes a reference to the originating ObjectPool for this Object. This will allow the Poolable Object to call back to the ObjectPool in order to be reclaimed.

Parameters:

pool - The parent ObjectPool

reclaim

public void reclaim()

reclaim prompts the Poolable object to return itself to the ObjectPool. A Poolable implementation should perform any necessary cleanup before calling pool.putObject to return itself to the ObjectPool.