com.almasb.fxgl.util

Interface Pooler

public interface Pooler

Pooler service. Allows users to get an instance of a class and pool it for future use.

Author:

Almas Baimagambetov (almaslvl@gmail.com)

Method Summary

Modifier and Type	Method and Description
<T> T	get(Class<T> type) Either an existing "free" pooled instance is returned or a new instance will be created.
void	put(Object object) Put the given object back to pool so it can reused.
<T> void	registerPool(Class<T> type, com.almasb.gameutils.pool.Pool<T> pool) Make the pooler use the given pool for given type.

Method Detail

get

<T> T get(Class<T> type)

Either an existing "free" pooled instance is returned or a new instance will be created.

Note: type class must have a public no-arg constructor.

Type Parameters:

T - type

Parameters:

type - type class

Returns:

pooled instance of given type

put

void put(Object object)

Put the given object back to pool so it can reused. The object will now be managed by the pool. After this call no attempt should be made to use the object. Any instance level fields must be "nulled".

Parameters:

object - the instance to return to pool

registerPool

<T> void registerPool(Class<T> type,
                      com.almasb.gameutils.pool.Pool<T> pool)

Make the pooler use the given pool for given type.

Type Parameters:

T - type

Parameters:

type - the object class

pool - the pool to use