de.joergdev.mosy.backend.standalone.pool

Class ObjectPool<T>

java.lang.Object

de.joergdev.mosy.backend.standalone.pool.ObjectPool<T>

Type Parameters:

T - Type of pool objects

public class ObjectPool<T>
extends Object

Generic Object Pool. By passing concurrent=true in the constructor, the pool is thread-safe.

Author:

Andreas Joerg

Field Summary

Fields

Modifier and Type	Field and Description
static long	TTL_UNLIMITED

Constructor Summary

Constructors

Constructor and Description
ObjectPool(boolean concurrent, IPoolMethods<T> impl) extended constructor.
ObjectPool(boolean concurrent, IPoolMethods<T> impl, int initialSize) extended constructor.
ObjectPool(boolean concurrent, IPoolMethods<T> impl, Lock lock) extended constructor.
ObjectPool(boolean concurrent, IPoolMethods<T> impl, Lock lock, int initialSize) extended constructor.
ObjectPool(IPoolMethods<T> impl) Constructor with IPoolMethods implementation param.
ObjectPool(IPoolMethods<T> impl, int initialSize) Constructor with IPoolMethods implementation param NOT threadsafe

Method Summary

Modifier and Type	Method and Description
void	flushPool() Remove all inactive (unlocked) objects from pool.
T	get() Internal method to obtain an object from the pool.
Lock	getLock()
int	getPoolSize() Returns the current number of objects in the pool.
int	getUnlockedCount() Returns the number of objects in the pool that are available.
void	giveBack(T obj) Release the object in pool.
void	setLock(Lock lock) Set an lock.

Methods inherited from class java.lang.Object

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

Field Detail

TTL_UNLIMITED

public static final long TTL_UNLIMITED

See Also:

Constant Field Values

Constructor Detail

ObjectPool

public ObjectPool(IPoolMethods<T> impl)

Constructor with IPoolMethods implementation param. NOT threadsafe

Parameters:

impl - - IPoolMethods

ObjectPool

public ObjectPool(IPoolMethods<T> impl,
                  int initialSize)

Constructor with IPoolMethods implementation param NOT threadsafe

Parameters:

impl - - IPoolMethods

initialSize - - Initial size of the pools. On startup, this number of objects will be created.

ObjectPool

public ObjectPool(boolean concurrent,
                  IPoolMethods<T> impl)

extended constructor. By passing concurrent=true in the constructor, the pool is thread-safe.

Parameters:

concurrent - - if true pool can handle concurrency

impl - - IPoolMethods

ObjectPool

public ObjectPool(boolean concurrent,
                  IPoolMethods<T> impl,
                  int initialSize)

extended constructor. By passing concurrent=true in the constructor, the pool is thread-safe.

Parameters:

concurrent - - if true pool can handle concurrency

impl - - IPoolMethods

initialSize - - Initial size of the pools. On startup, this number of objects will be created

ObjectPool

public ObjectPool(boolean concurrent,
                  IPoolMethods<T> impl,
                  Lock lock)

extended constructor. By passing concurrent=true in the constructor, the pool is thread-safe A lock object must also be passed. However, if the pool uses concurrent, it is recommended to use the constructor ObjectPool(boolean concurrent, IPoolMethods<T> impl). Here, a ReentrantLock is automatically set as the lock.

Parameters:

concurrent - - if true pool can handle concurrency

impl - - IPoolMethods

lock - - Lock to set

ObjectPool

public ObjectPool(boolean concurrent,
                  IPoolMethods<T> impl,
                  Lock lock,
                  int initialSize)

extended constructor. By passing concurrent=true in the constructor, the pool is thread-safe A lock object must also be passed. However, if the pool uses concurrent, it is recommended to use the constructor ObjectPool(boolean concurrent, IPoolMethods<T> impl). Here, a ReentrantLock is automatically set as the lock.

Parameters:

concurrent - - if true pool can handle concurrency

impl - - IPoolMethods

lock - - Lock to set

initialSize - - Initial size of the pools. On startup, this number of objects will be created

Method Detail

getLock

public Lock getLock()

Returns:

lock

setLock

public void setLock(Lock lock)

Set an lock.

Parameters:

lock - - Lock to set

Throws:

NullPointerException - - if lock is null (use NullLock)

See Also:

NullLock

get

public T get()

Internal method to obtain an object from the pool.

Returns:

T

giveBack

public void giveBack(T obj)

Release the object in pool.

Parameters:

obj - - object in pool

getPoolSize

public int getPoolSize()

Returns the current number of objects in the pool.

Returns:

int

getUnlockedCount

public int getUnlockedCount()

Returns the number of objects in the pool that are available.

Returns:

int

flushPool

public void flushPool()

Remove all inactive (unlocked) objects from pool.