org.vibur.objectpool

Class AbstractValidatingPoolService<T>

java.lang.Object

org.vibur.objectpool.AbstractBasePoolService

org.vibur.objectpool.AbstractValidatingPoolService<T>

Type Parameters:

T - the type of objects held in this object pool

All Implemented Interfaces:

BasePoolService

Direct Known Subclasses:

ConcurrentHolderLinkedPool

public abstract class AbstractValidatingPoolService<T>
extends AbstractBasePoolService
implements BasePoolService

Base abstract class which is to be extended and which provides common functionality for validating object pool's implementations. Implemented via composition with a non-validating object pool on top of which the validation will be implemented.

Author:

Simeon Malchev

Method Summary

Methods

Modifier and Type	Method and Description
int	createdTotal() Returns the total number of created objects which currently exist for this object pool.
int	initialSize() Returns the initialSize of this object pool at construction time.
boolean	isFair() Returns the fairness setting of this object pool.
boolean	isTerminated() Returns the current terminated state of this object pool.
int	maxSize() Returns the maxSize of this object pool.
int	reduceCreated(int reduction, boolean ignoreInitialSize) Tries to remove (and destroy) up to reduction objects from the object pool.
int	remainingCapacity() Returns the remaining capacity of this object pool, i.e.
void	terminate() Terminates this object pool.

Methods inherited from class org.vibur.objectpool.AbstractBasePoolService

drainCreated, remainingCreated, taken, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vibur.objectpool.BasePoolService

drainCreated, remainingCreated, taken

Method Detail

createdTotal

public int createdTotal()

Returns the total number of created objects which currently exist for this object pool. This number is equal to BasePoolService.taken() + BasePoolService.remainingCreated(). Typically used for testing an debugging purposes.

Specified by:

createdTotal in interface BasePoolService

Returns:

the total number of created objects for this object pool

remainingCapacity

public int remainingCapacity()

Returns the remaining capacity of this object pool, i.e. the number of objects which could be taken from this object pool without blocking. It is not guaranteed that all these objects exist at the time of the call (i.e. are already created) in the object pool - some of them might be created on demand upon take requests. Also see BasePoolService.remainingCreated(). Typically used for testing an debugging purposes.

Specified by:

remainingCapacity in interface BasePoolService

Returns:

the object pool's remaining capacity

initialSize

public int initialSize()

Returns the initialSize of this object pool at construction time. This parameter never changes.

Specified by:

initialSize in interface BasePoolService

Returns:

the object pool's initialSize

maxSize

public int maxSize()

Returns the maxSize of this object pool. This parameter never changes.

Specified by:

maxSize in interface BasePoolService

Returns:

the object pool's maxSize

reduceCreated

public int reduceCreated(int reduction,
                boolean ignoreInitialSize)

Tries to remove (and destroy) up to reduction objects from the object pool. May bring the object pool's BasePoolService.createdTotal() to less then its BasePoolService.initialSize().

Specified by:

reduceCreated in interface BasePoolService

Parameters:

reduction - the desired amount of objects to be removed

ignoreInitialSize - specifies whether the BasePoolService.createdTotal() may be reduced to less than BasePoolService.initialSize()

Returns:

the actual amount of objects removed

terminate

public void terminate()

Terminates this object pool. Once terminated the object pool cannot be more revived. All take and restore operations called on a terminated object pool should throw an exception or be ignored. Invocation has no additional effect if already terminated.

Specified by:

terminate in interface BasePoolService

isTerminated

public boolean isTerminated()

Returns the current terminated state of this object pool.

Specified by:

isTerminated in interface BasePoolService

Returns:

true if the object pool is terminated

isFair

public boolean isFair()

Returns the fairness setting of this object pool.

Specified by:

isFair in interface BasePoolService

Returns:

true if the object pool is fair to waiting taker threads