net.lecousin.framework.memory

Class ObjectBank<T>

java.lang.Object

net.lecousin.framework.memory.ObjectBank<T>

Type Parameters:

T - type of object

All Implemented Interfaces:

Closeable, AutoCloseable, IMemoryManageable

public class ObjectBank<T>
extends Object
implements IMemoryManageable, Closeable

A bank of objects that holds unused instances for reuse. Each time a new instance is requested, if an unused one is present it returns it, else it create a new one. Each time an instance if released, it keeps it for future reuse (with a maximum number of unused instances to keep).

Nested Class Summary

Nested classes/interfaces inherited from interface net.lecousin.framework.memory.IMemoryManageable

IMemoryManageable.FreeMemoryLevel

Constructor Summary

Constructors

Constructor and Description
ObjectBank(int maxSize, String description) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
void	free(T object) Release an instance.
void	freeMemory(IMemoryManageable.FreeMemoryLevel level) Request to free some memory.
T	get() Get an instance.
String	getDescription() Desciption.
List<String>	getItemsDescription() Describe each item that can be freed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectBank

public ObjectBank(int maxSize,
                  String description)

Constructor.

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

get

public T get()

Get an instance.

free

public void free(T object)

Release an instance.

getDescription

public String getDescription()

Description copied from interface: IMemoryManageable

Desciption.

Specified by:

getDescription in interface IMemoryManageable

getItemsDescription

public List<String> getItemsDescription()

Description copied from interface: IMemoryManageable

Describe each item that can be freed.

Specified by:

getItemsDescription in interface IMemoryManageable

freeMemory

public void freeMemory(IMemoryManageable.FreeMemoryLevel level)

Description copied from interface: IMemoryManageable

Request to free some memory.

Specified by:

freeMemory in interface IMemoryManageable