org.oscim.utils.pool

Class SyncPool<T extends Inlist<?>>

java.lang.Object

org.oscim.utils.pool.SyncPool<T>

Direct Known Subclasses:

TextureItem.TexturePool

public abstract class SyncPool<T extends Inlist<?>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mClearItems
protected int	mFill
protected int	mMaxFill
protected T	mPool

Constructor Summary

Constructors

Constructor and Description
SyncPool(int maxItemsInPool)
SyncPool(int maxItemsInPool, boolean clearItems)

Method Summary

Modifier and Type	Method and Description
void	clear()
protected boolean	clearItem(T item)
protected abstract T	createItem() Creates the item.
protected void	freeItem(T item)
T	get() Gets an 'item' from pool, if pool is empty a new item will be created by createItem().
int	getFill()
void	init(int items) To be implemented by subclass.
T	release(T item) Release 'item' to pool.
T	releaseAll(T item) Release 'list' to pool.

Methods inherited from class java.lang.Object

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

Field Detail

mMaxFill

protected final int mMaxFill

mClearItems

protected final boolean mClearItems

mFill

protected int mFill

mPool

protected T extends Inlist<?> mPool

Constructor Detail

SyncPool

public SyncPool(int maxItemsInPool)

SyncPool

public SyncPool(int maxItemsInPool,
                boolean clearItems)

Method Detail

getFill

public int getFill()

init

public void init(int items)

To be implemented by subclass.

Parameters:

items - number of initial items

clear

public void clear()

clearItem

protected boolean clearItem(T item)

Parameters:

item - set initial state

Returns:

'true' when item should be added back to pool, 'false' when freeItem should be called.

freeItem

protected void freeItem(T item)

Parameters:

item - release resources

createItem

protected abstract T createItem()

Creates the item. To be implemented by subclass.

Returns:

the item

release

@CheckReturnValue
public T release(T item)

Release 'item' to pool.

Usage item = pool.release(item), to ensure to not keep a reference to item!

releaseAll

@CheckReturnValue
public T releaseAll(T item)

Release 'list' to pool.

Usage list = pool.releaseAll(list), to ensure to not keep a reference to list!

get

public T get()

Gets an 'item' from pool, if pool is empty a new item will be created by createItem().

Returns:

the item