DESY ACOP Beans Home

com.cosylab.util
Interface PoolableObject

public interface PoolableObject

An object that is able of being recycled and stored in an object pool. This object must support:

• Resurrection. When no other objects reference this object, this object may be garbage collected. Usually - if this is a small instance that is used (created) a lot of times, garbage collection will occur. In the finalize method, this object must call its objectPool and invoke method returnToPool on it. In this way, the object pool will contain a reference to this, making this object strongly reachable (see Java reference for explanation) after finalization and consequently making this object resurrected.
• State reset. In order to make this object useful again, it must support clear method. This method must force the object into the same state that it achieved during construction. Since object pools are mainly used for data holder objects, this would imply a reset of all data fields to their default values.
• Holding a reference to the pool. This reference is set through setObjectPool when the object is instantiated by the pool automatically, OR must be set by hand when the object is constructed manually.

Note that object pools are mostly usable for simple data holder objects, which are created in great amounts and are also frequently released. This means that the receivers of these objects simply inspect some values (or even do nothing), after which they have no more use for the object and do not store it in some sort of data container structure.

Method Summary

void	clear() Clears the contents (data fields) of this object by resetting them to the uninitialized (after construction) values.
void	setObjectPool(ObjectPool pool) Sets the object pool to which this object belongs.

Method Detail

clear

void clear()

Clears the contents (data fields) of this object by resetting them to the uninitialized (after construction) values.

setObjectPool

void setObjectPool(ObjectPool pool)

Sets the object pool to which this object belongs. During finalization of this object, it will attempt to resurrect itself by returning to the object pool.

Parameters:

pool - the pool to which this object will return