com.almasb.fxgl.core.pool

Class Pool<T>

java.lang.Object

com.almasb.fxgl.core.pool.Pool<T>

Direct Known Subclasses:

ReflectionPool

public abstract class Pool<T>
extends Object

A pool of objects that can be reused to avoid allocation.

Author:

Nathan Sweet

See Also:

Pools

Field Summary

Fields

Modifier and Type	Field and Description
int	max The maximum number of objects that will be pooled.

Constructor Summary

Constructors

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

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(Array<T> objects) Puts the specified objects in the pool.
int	getFree() The number of objects available to be obtained.
protected abstract T	newObject()
T	obtain() The object may be new (from newObject()) or reused (previously freed).
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 java.lang.Object

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

Field Detail

max

public final int max

The maximum number of objects that will be pooled.

Constructor Detail

Pool

public Pool()

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

Pool

public Pool(int initialCapacity)

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

Parameters:

initialCapacity - initial pool capacity

Pool

public Pool(int initialCapacity,
            int max)

Creates a pool with the specified initial capacity and maximum.

Parameters:

initialCapacity - initial pool capacity

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

Method Detail

newObject

protected abstract T newObject()

Returns:

a newly constructed object

obtain

public T obtain()

The object may be new (from newObject()) or reused (previously freed).

Returns:

a pooled object

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 max free objects, the specified object is reset but not added to the pool.

Parameters:

object - the object to put in the pool

Throws:

IllegalArgumentException - if object is null

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.

Parameters:

object - the object to free

freeAll

public void freeAll(Array<T> objects)

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

Parameters:

objects - an array of objects to put back in the pool

Throws:

IllegalArgumentException - if objects is null

See Also:

free(Object)

clear

public void clear()

Removes all free objects from this pool.

getFree

public int getFree()

The number of objects available to be obtained.