org.mini2Dx.core.collections.concurrent

Class ConcurrentPool<T>

java.lang.Object

org.mini2Dx.gdx.utils.Pool<T>

org.mini2Dx.core.collections.concurrent.ConcurrentPool<T>

All Implemented Interfaces:

ConcurrentCollection

public abstract class ConcurrentPool<T>
extends org.mini2Dx.gdx.utils.Pool<T>
implements ConcurrentCollection

Nested Class Summary

Nested classes/interfaces inherited from class org.mini2Dx.gdx.utils.Pool

org.mini2Dx.gdx.utils.Pool.Poolable

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	lock

Fields inherited from class org.mini2Dx.gdx.utils.Pool

max, peak

Constructor Summary

Constructors

Constructor and Description
ConcurrentPool() Creates a pool with an initial capacity of 16 and no maximum.
ConcurrentPool(int initialCapacity) Creates a pool with the specified initial capacity and no maximum.
ConcurrentPool(int initialCapacity, int max)

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all free objects from this pool.
void	free(T object) Puts the specified object in the pool, making it eligible to be returned by obtain().
void	freeAll(org.mini2Dx.gdx.utils.Array<T> objects) Puts the specified objects in the pool.
int	getFree() The number of objects available to be obtained.
ReadWriteLock	getLock() Returns the collection's ReadWriteLock
T	obtain() Returns an object from this pool.
protected void	reset(T object) Called when an object is freed to clear the state of the object for possible later reuse.

Methods inherited from class org.mini2Dx.gdx.utils.Pool

newObject

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected ReadWriteLock lock

Constructor Detail

ConcurrentPool

public ConcurrentPool()

Creates a pool with an initial capacity of 16 and no maximum.

ConcurrentPool

public ConcurrentPool(int initialCapacity)

Creates a pool with the specified initial capacity and no maximum.

Parameters:

initialCapacity -

ConcurrentPool

public ConcurrentPool(int initialCapacity,
                      int max)

Parameters:

initialCapacity -

max - The maximum number of free objects to store in this pool.

Method Detail

obtain

public T obtain()

Returns an object from this pool. The object may be new (from Pool.newObject()) or reused (previously freed).

Overrides:

obtain in class org.mini2Dx.gdx.utils.Pool<T>

free

public void free(T object)

Puts the specified object in the pool, making it eligible to be returned by obtain(). If the pool already contains Pool.max free objects, the specified object is reset but not added to the pool.

The pool does not check if an object is already freed, so the same object must not be freed multiple times.

Overrides:

free in class org.mini2Dx.gdx.utils.Pool<T>

Parameters:

object -

reset

protected void reset(T object)

Called when an object is freed to clear the state of the object for possible later reuse. The default implementation calls Poolable#reset() if the object is Poolable.

Overrides:

reset in class org.mini2Dx.gdx.utils.Pool<T>

Parameters:

object -

freeAll

public void freeAll(org.mini2Dx.gdx.utils.Array<T> objects)

Puts the specified objects in the pool. Null objects within the array are silently ignored.

The pool does not check if an object is already freed, so the same object must not be freed multiple times.

Overrides:

freeAll in class org.mini2Dx.gdx.utils.Pool<T>

Parameters:

objects -

See Also:

free(Object)

clear

public void clear()

Removes all free objects from this pool.

Overrides:

clear in class org.mini2Dx.gdx.utils.Pool<T>

getFree

public int getFree()

The number of objects available to be obtained.

Overrides:

getFree in class org.mini2Dx.gdx.utils.Pool<T>

getLock

public ReadWriteLock getLock()

Description copied from interface: ConcurrentCollection

Returns the collection's ReadWriteLock

Specified by:

getLock in interface ConcurrentCollection

Returns:

the collection's ReadWriteLock