com.almasb.fxgl.core.pool

Class Pools

java.lang.Object

com.almasb.fxgl.core.pool.Pools

public final class Pools
extends Object

Stores a map of Pools (usually ReflectionPools) by type for convenient static access.

Author:

Nathan Sweet

Method Summary

Modifier and Type	Method and Description
static void	free(Object object) Frees an object from the pool.
static void	freeAll(Array objects) Frees the specified objects from the pool.
static void	freeAll(Array objects, boolean samePool) Frees the specified objects from the pool.
static void	freeAll(Object... objects) Frees all given objects.
static <T> Pool<T>	get(Class<T> type) The max size of the pool used is 100.
static <T> Pool<T>	get(Class<T> type, int max) Returns a new or existing pool for the specified type, stored in a Class to Pool map.
static <T> T	obtain(Class<T> type)
static <T> void	set(Class<T> type, Pool<T> pool) Sets an existing pool for the specified type, stored in a Class to Pool map.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static <T> Pool<T> get(Class<T> type,
                              int max)

Returns a new or existing pool for the specified type, stored in a Class to Pool map. Note the max size is ignored if this is not the first time this pool has been requested.

get

public static <T> Pool<T> get(Class<T> type)

The max size of the pool used is 100.

Type Parameters:

T - pool type

Parameters:

type - pool class

Returns:

a new or existing pool for the specified type, stored in a Class to Pool map

set

public static <T> void set(Class<T> type,
                           Pool<T> pool)

Sets an existing pool for the specified type, stored in a Class to Pool map.

Type Parameters:

T - pool type

Parameters:

type - pool class

pool - pool object

obtain

public static <T> T obtain(Class<T> type)

Type Parameters:

T - object type

Parameters:

type - object class

Returns:

an object from the pool

free

public static void free(Object object)

Frees an object from the pool.

Parameters:

object - the object to free

freeAll

public static void freeAll(Array objects)

Frees the specified objects from the pool. Null objects within the array are silently ignored. Objects don't need to be from the same pool.

Parameters:

objects - objects to be freed

freeAll

public static void freeAll(Array objects,
                           boolean samePool)

Frees the specified objects from the pool. Null objects within the array are silently ignored.

Parameters:

objects - objects to free

samePool - if false, objects don't need to be from the same pool but the pool must be looked up for each object

freeAll

public static void freeAll(Object... objects)

Frees all given objects.

Parameters:

objects - to free