org.restcomm.media.spi.pooling

Class AbstractResourcePool<T extends PooledObject>

java.lang.Object

org.restcomm.media.spi.pooling.AbstractResourcePool<T>

All Implemented Interfaces:

ResourcePool<T>

Direct Known Subclasses:

AbstractConcurrentResourcePool

public abstract class AbstractResourcePool<T extends PooledObject>
extends Object
implements ResourcePool<T>

Abstraction of a ResourcePool that relies on an internal queue to maintain the collection of resources.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourcePool(Queue<T> resources, int initialCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
int	count() Counts the number of idle elements in the pool.
protected abstract T	createResource()
boolean	isEmpty() Checks whether the pool contains at least one element.
void	offer(T resource) Offers an object to be placed into the pool.
T	poll() Polls an object from the pool. If the pool is empty, a new object shall be created.
protected void	populate() Populates the pool with new objects until the initial capacity is reached.
void	release() Releases all resources held by the pool.
int	size() Gets the maximum size of the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourcePool

protected AbstractResourcePool(Queue<T> resources,
                    int initialCapacity)

Method Detail

populate

protected void populate()

Populates the pool with new objects until the initial capacity is reached.

IMPORTANT: This method should be manually invoked by the constructor of each implementation.
The reason is that some more complex objects require dependencies or factories.

poll

public T poll()

Description copied from interface: ResourcePool

Polls an object from the pool.
If the pool is empty, a new object shall be created.

Specified by:

poll in interface ResourcePool<T extends PooledObject>

Returns:

An object from the pool.

offer

public void offer(T resource)

Description copied from interface: ResourcePool

Offers an object to be placed into the pool.

Specified by:

offer in interface ResourcePool<T extends PooledObject>

Parameters:

resource - The object to be placed into the pool.

release

public void release()

Description copied from interface: ResourcePool

Releases all resources held by the pool.

Specified by:

release in interface ResourcePool<T extends PooledObject>

count

public int count()

Description copied from interface: ResourcePool

Counts the number of idle elements in the pool.

Specified by:

count in interface ResourcePool<T extends PooledObject>

Returns:

the number of elements in the pool.

size

public int size()

Description copied from interface: ResourcePool

Gets the maximum size of the pool.

Specified by:

size in interface ResourcePool<T extends PooledObject>

Returns:

The pool size

isEmpty

public boolean isEmpty()

Description copied from interface: ResourcePool

Checks whether the pool contains at least one element.

Specified by:

isEmpty in interface ResourcePool<T extends PooledObject>

Returns:

Returns true is empty, false otherwise.

createResource

protected abstract T createResource()