org.vibur.objectpool

Interface PoolObjectFactory<T>

Type Parameters:

T - the type of objects held in this object pool

public interface PoolObjectFactory<T>

Defines an interface which is to be implemented by a factory which will be used by the pools defined in this package to control the lifecycle of the object pool's objects.

Author:

Simeon Malchev

Method Summary

Methods

Modifier and Type	Method and Description
T	create() Creates a new object pool's object, which is presumed to be ready (and valid) for immediate use.
void	destroy(T obj) A method which will be called when an object from the object pool needs to be destroyed, which may happen after a validation/initialization/passivation error or when the object pool is shrinking its size or terminating.
boolean	readyToRestore(T obj) A validation/passivation hook which will be called when an object which has been taken before that from the object pool is about to be restored (returned) back to the object pool.
boolean	readyToTake(T obj) A validation/initialization hook which will be called when an object from the object pool is taken in order to be given to the calling application.

Method Detail

create

T create()

Creates a new object pool's object, which is presumed to be ready (and valid) for immediate use. Should never return null.

Returns:

new object pool's object.

readyToTake

boolean readyToTake(T obj)

A validation/initialization hook which will be called when an object from the object pool is taken in order to be given to the calling application. This is an optional operation and the concrete implementation of this method may always simply return true.

If there is a particular initialization/activation which needs to be done for this object, it can be done here.

Parameters:

obj - an object which is taken from the object pool and which is to be given to the calling application

Returns:

true if the validation/initialization is successful, false otherwise

See Also:

readyToRestore(Object)

readyToRestore

boolean readyToRestore(T obj)

A validation/passivation hook which will be called when an object which has been taken before that from the object pool is about to be restored (returned) back to the object pool. This is an optional operation and the concrete implementation of this method may always simply return true.

If there is a particular passivation which needs to be done for this object, it can be done here.

Parameters:

obj - an object which has been taken before that from this object pool and which is now to be restored to the object pool

Returns:

true if the validation/passivation is successful, false otherwise

See Also:

readyToTake(T)

destroy

void destroy(T obj)

A method which will be called when an object from the object pool needs to be destroyed, which may happen after a validation/initialization/passivation error or when the object pool is shrinking its size or terminating. The simplest implementation of this method may do nothing, however if there are any allocated resources associated with this object, like network connections or similar, this will be the best place where these resources could be released.

Parameters:

obj - the object which is to be destroyed