com.helger.commons.pool

Class ObjectPool<DATATYPE>

java.lang.Object

com.helger.commons.pool.ObjectPool<DATATYPE>

Type Parameters:

DATATYPE - The type of the objects contained in the pool.

All Implemented Interfaces:

IMutableObjectPool<DATATYPE>

@ThreadSafe
public final class ObjectPool<DATATYPE>
extends Object
implements IMutableObjectPool<DATATYPE>

A simple generic object pool with a fixed size determined in the constructor.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ObjectPool(int nItemCount, ISupplier<? extends DATATYPE> aFactory) Create a new object pool for a certain amount of items and a factory that creates the objects on demand.

Method Summary

Modifier and Type	Method and Description
DATATYPE	borrowObject() Borrow an object from the pool.
void	clearUnusedItems()
ESuccess	returnObject(DATATYPE aItem) Return a previously borrowed object back to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPool

public ObjectPool(@Nonnegative
                  int nItemCount,
                  @Nonnull
                  ISupplier<? extends DATATYPE> aFactory)

Create a new object pool for a certain amount of items and a factory that creates the objects on demand.

Parameters:

nItemCount - The number of items in the pool. Must be ≥ 1.

aFactory - The factory to create object. May not be null. The factory may not create null objects, as this leads to an error!

Method Detail

clearUnusedItems

public void clearUnusedItems()

borrowObject

@Nullable
public DATATYPE borrowObject()

Description copied from interface: IMutableObjectPool

Borrow an object from the pool. This method blocks until an object is available.

Specified by:

borrowObject in interface IMutableObjectPool<DATATYPE>

Returns:

The borrowed object. May be null depending on the factory, and the locking used.

returnObject

@Nonnull
public ESuccess returnObject(@Nonnull
                                       DATATYPE aItem)

Description copied from interface: IMutableObjectPool

Return a previously borrowed object back to the pool.

Specified by:

returnObject in interface IMutableObjectPool<DATATYPE>

Parameters:

aItem - The previously borrowed object to be returned. Never null.

Returns:

ESuccess.SUCCESS upon success