com.badlogic.gdx.utils

Class FlushablePool<T>

java.lang.Object

com.badlogic.gdx.utils.Pool<T>

com.badlogic.gdx.utils.FlushablePool<T>

Direct Known Subclasses:

ModelBatch.RenderablePool

public abstract class FlushablePool<T>
extends Pool<T>

A Pool which keeps track of the obtained items (see obtain()), which can be free'd all at once using the flush() method.

Author:

Xoppa

Nested Class Summary

Nested classes/interfaces inherited from class com.badlogic.gdx.utils.Pool

Pool.Poolable

Field Summary

Fields

Modifier and Type	Field and Description
protected Array<T>	obtained

Fields inherited from class com.badlogic.gdx.utils.Pool

max, peak

Constructor Summary

Constructors

Constructor and Description
FlushablePool()
FlushablePool(int initialCapacity)
FlushablePool(int initialCapacity, int max)

Method Summary

Modifier and Type	Method and Description
void	flush() Frees all obtained instances.
void	free(T object) Puts the specified object in the pool, making it eligible to be returned by Pool.obtain().
void	freeAll(Array<T> objects) Puts the specified objects in the pool.
T	obtain() Returns an object from this pool.

Methods inherited from class com.badlogic.gdx.utils.Pool

clear, getFree, newObject, reset

Methods inherited from class java.lang.Object

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

Field Detail

obtained

protected Array<T> obtained

Constructor Detail

FlushablePool

public FlushablePool()

FlushablePool

public FlushablePool(int initialCapacity)

FlushablePool

public FlushablePool(int initialCapacity,
                     int max)

Method Detail

obtain

public T obtain()

Description copied from class: Pool

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

Overrides:

obtain in class Pool<T>

flush

public void flush()

Frees all obtained instances.

free

public void free(T object)

Description copied from class: Pool

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

Overrides:

free in class Pool<T>

freeAll

public void freeAll(Array<T> objects)

Description copied from class: Pool

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

Overrides:

freeAll in class Pool<T>

See Also:

Pool.free(Object)