org.carrot2.util.pool

Class SoftUnboundedPool<T,P>

java.lang.Object

org.carrot2.util.pool.SoftUnboundedPool<T,P>

All Implemented Interfaces:

IParameterizedPool<T,P>

public final class SoftUnboundedPool<T,P>
extends Object
implements IParameterizedPool<T,P>

An extremely simple, unbounded object pool. The pool can provide objects of may types, objects get created using parameterless constructors. The pool holds objects using SoftReferences, so they can be garbage collected when memory is needed.

Constructor Summary

Constructors

Constructor and Description
SoftUnboundedPool()

Method Summary

Methods

Modifier and Type	Method and Description
<I extends T> I	borrowObject(Class<I> clazz, P parameter) Borrows an object from the pool.
void	dispose() Disposes of the pool.
void	init(IInstantiationListener<T,P> objectInstantiationListener, IActivationListener<T,P> objectActivationListener, IPassivationListener<T,P> objectPassivationListener, IDisposalListener<T,P> objectDisposalListener) Initializes the pool with a number of listeners.
void	returnObject(T object, P parameter) Returns an object to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftUnboundedPool

public SoftUnboundedPool()

Method Detail

init

public void init(IInstantiationListener<T,P> objectInstantiationListener,
        IActivationListener<T,P> objectActivationListener,
        IPassivationListener<T,P> objectPassivationListener,
        IDisposalListener<T,P> objectDisposalListener)

Description copied from interface: IParameterizedPool

Initializes the pool with a number of listeners. The appropriate listeners must be called at the relevant stages of a pooled object's life cycle.

Specified by:

init in interface IParameterizedPool<T,P>

borrowObject

public <I extends T> I borrowObject(Class<I> clazz,
                           P parameter)
                         throws InstantiationException,
                                IllegalAccessException

Description copied from interface: IParameterizedPool

Borrows an object from the pool. If no instance is available, a parameterless constructor should be used to create a new one.

Specified by:

borrowObject in interface IParameterizedPool<T,P>

Parameters:

clazz - class of object to be borrowed

parameter - additional parameter determining a possible sub type within the same class of objects being borrowed. A combination of class and parameter uniquely identifies a "class" (equivalence class) of pooled objects. The parameter is assumed to correctly implement the Object.equals(Object) and Object.hashCode() methods. The parameter can be null. The implementation must pass the parameter to all listeners when managing the life cycle of the pooled object. It is the callers responsibility to ensure that exactly the same value of the parameter is passed to the corresponding IParameterizedPool.borrowObject(Class, Object) and IParameterizedPool.returnObject(Object, Object) methods.

Throws:

InstantiationException

IllegalAccessException

returnObject

public void returnObject(T object,
                P parameter)

Description copied from interface: IParameterizedPool

Returns an object to the pool.

Specified by:

returnObject in interface IParameterizedPool<T,P>

Parameters:

object - object to return

parameter - parameter provided when borrowing the object. If the parameter was not null when borrowing the object, the same value will be passed here.

dispose

public void dispose()

Description copied from interface: IParameterizedPool

Disposes of the pool. No objects can be borrowed from the pool after disposed.

Specified by:

dispose in interface IParameterizedPool<T,P>