Package net.haesleinhuepf.clij.coremem.recycling

Class BasicRecycler<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

java.lang.Object

net.haesleinhuepf.clij.coremem.rgc.FreeableBase

net.haesleinhuepf.clij.coremem.recycling.BasicRecycler<R,P>

Type Parameters:

R - Recyclable type

P - Request type (P stands for request Parameter)

All Implemented Interfaces:

RecyclerInterface<R,P>, Freeable

public class BasicRecycler<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>
extends FreeableBase
implements RecyclerInterface<R,P>, Freeable

Basic Recycler. The basic recycler uses a single queue to hold recycled objects. When a request cannot be satisfied by any recycled objects, then these objects are released and new objects are created according to the request.

Author:

royer

Constructor Summary

Constructors

Constructor	Description
BasicRecycler(RecyclableFactoryInterface<R,P> pRecyclableFactory, int pMaximumNumberOfObjects)	Instanciates a basic recycler with a given recyclable factory and maximum number of objects.
BasicRecycler(RecyclableFactoryInterface<R,P> pRecyclableFactory, int pMaximumNumberOfLiveObjects, int pMaximumNumberOfAvailableObjects, boolean pAutoFree)	Instanciates a basic recycler with a given recyclable factory and maximum number of live and available objects.

Method Summary

Modifier and Type	Method	Description
void	addListener(RecyclerListenerInterface pRecyclerListener)	Adds a recycler listener to this recycler.
void	clearLive()	Clears the list of live objects and frees them if the 'autofree' flag is set
void	clearReleased()	Clears the list of available objects and frees them if the 'autofree' flag is set.
long	computeAvailableMemorySizeInBytes()	Returns the calculated total size in bytes of available objects.
long	computeLiveMemorySizeInBytes()	Returns the calculated total size in bytes of live objects.
long	ensurePreallocated(long pNumberofPrealocatedRecyclablesNeeded, P pRecyclerRequest)	Ensures that a given number of recyclable objects are available.
void	free()	Free this object, which means that the underlying ressources are released.
R	get(boolean pWaitForLiveObjectToComeBack, long pWaitTime, TimeUnit pTimeUnit, P pRecyclerRequest)	Requests a recyclable object (all other get methods delegate to this one).
TimeUnit	getAvailableQueueTimeUnit()	Returns the available queue time unit
long	getAvailableQueueWaitTime()	Returns the waiting time for the available queue.
int	getMaxNumberOfAvailableObjects()	Returns the maximum number of available objects allowed.
int	getMaxNumberOfLiveObjects()	Returns the maximum number of live objects allowed.
int	getNumberOfAvailableObjects()	Returns the current number of recyclable objects available for recycling.
long	getNumberOfFailedRequests()	Returns the number of failed requests.
int	getNumberOfLiveObjects()	Returns the current number of live objects - these are objects that are curently in use and thus not available for recycling.
R	getOrFail(P pRecyclerRequest)	Attempts to get a recyclable object from this recycler for a given request.
R	getOrWait(long pWaitTime, TimeUnit pTimeUnit, P pRecyclerRequest)	Waits for a given amount of time to return a recyclable object given a request.
boolean	isFree()	Returns true if the object has been freed, which usually means that the underlying ressources are not longer available.
void	printDebugInfo()	BELOW ARE DEBUG METHODS:
void	release(R pRecyclable)	Releases the given object
void	removeListener(RecyclerListenerInterface pRecyclerListener)	Remioves a recycler listener to this recycler.
void	setAvailableQueueWaitingTime(long pAvailableQueueWaitTime, TimeUnit pTimeUnit)	Sets the waiting time for the available queue.

Methods inherited from class net.haesleinhuepf.clij.coremem.rgc.FreeableBase

complainIfFreed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.haesleinhuepf.clij.coremem.rgc.Freeable

complainIfFreed

Constructor Detail

BasicRecycler

public BasicRecycler(RecyclableFactoryInterface<R,P> pRecyclableFactory,
                     int pMaximumNumberOfObjects)

Instanciates a basic recycler with a given recyclable factory and maximum number of objects. This number of objects is split evenly between live and available objects.

Parameters:

pRecyclableFactory - factory capable of instanciating recyclables

pMaximumNumberOfObjects - maximum number of objects (live + availables)

BasicRecycler

public BasicRecycler(RecyclableFactoryInterface<R,P> pRecyclableFactory,
                     int pMaximumNumberOfLiveObjects,
                     int pMaximumNumberOfAvailableObjects,
                     boolean pAutoFree)

Instanciates a basic recycler with a given recyclable factory and maximum number of live and available objects. A flag determines whether released objects should also be freed.

Parameters:

pRecyclableFactory - factory capable of instanciating recyclables

pMaximumNumberOfLiveObjects - maximum number of live objects

pMaximumNumberOfAvailableObjects - maximum number of available objects

pAutoFree - true free released/cleared objects.

Method Detail

setAvailableQueueWaitingTime

public void setAvailableQueueWaitingTime(long pAvailableQueueWaitTime,
                                         TimeUnit pTimeUnit)

Sets the waiting time for the available queue. A long integer and time unit must be provided.

Parameters:

pAvailableQueueWaitTime - time

pTimeUnit - time unit

getAvailableQueueWaitTime

public long getAvailableQueueWaitTime()

Returns the waiting time for the available queue.

Returns:

witing time, call getAvailableQueueTimeUnit() to get the corresponding time unit.

getAvailableQueueTimeUnit

public TimeUnit getAvailableQueueTimeUnit()

Returns the available queue time unit

Returns:

available queue time unit

addListener

public void addListener(RecyclerListenerInterface pRecyclerListener)

Description copied from interface: RecyclerInterface

Adds a recycler listener to this recycler.

Specified by:

addListener in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pRecyclerListener - recycler listener

removeListener

public void removeListener(RecyclerListenerInterface pRecyclerListener)

Description copied from interface: RecyclerInterface

Remioves a recycler listener to this recycler.

Specified by:

removeListener in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pRecyclerListener - recycler listener

ensurePreallocated

public long ensurePreallocated(long pNumberofPrealocatedRecyclablesNeeded,
                               P pRecyclerRequest)

Description copied from interface: RecyclerInterface

Ensures that a given number of recyclable objects are available.

Specified by:

ensurePreallocated in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pNumberofPrealocatedRecyclablesNeeded - number of preallocated recyclables

pRecyclerRequest - request to use for instanciating the recyclable objects

Returns:

effective number of recyclable objects allocated.

getOrWait

public R getOrWait(long pWaitTime,
                   TimeUnit pTimeUnit,
                   P pRecyclerRequest)

Description copied from interface: RecyclerInterface

Waits for a given amount of time to return a recyclable object given a request.

Specified by:

getOrWait in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pWaitTime - wait time

pTimeUnit - wait time unit

pRecyclerRequest - request

Returns:

null if fails to get a new recyclable object before timeout

getOrFail

public R getOrFail(P pRecyclerRequest)

Description copied from interface: RecyclerInterface

Attempts to get a recyclable object from this recycler for a given request. This call might fail in which case a null reference is returned.

Specified by:

getOrFail in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pRecyclerRequest - request

Returns:

null if failed to get a recyclable.

get

public R get(boolean pWaitForLiveObjectToComeBack,
             long pWaitTime,
             TimeUnit pTimeUnit,
             P pRecyclerRequest)

Description copied from interface: RecyclerInterface

Requests a recyclable object (all other get methods delegate to this one).

Specified by:

get in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pWaitForLiveObjectToComeBack - as it names suggest, this flag causes this call to wait until an object is available.

pWaitTime - wait time

pTimeUnit - wait time unit

pRecyclerRequest - request

Returns:

null if fails or timeout

release

public void release(R pRecyclable)

Description copied from interface: RecyclerInterface

Releases the given object

Specified by:

release in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Parameters:

pRecyclable - recyclable object to release

getMaxNumberOfLiveObjects

public int getMaxNumberOfLiveObjects()

Description copied from interface: RecyclerInterface

Returns the maximum number of live objects allowed.

Specified by:

getMaxNumberOfLiveObjects in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

maximum number of live objects allowed

getMaxNumberOfAvailableObjects

public int getMaxNumberOfAvailableObjects()

Description copied from interface: RecyclerInterface

Returns the maximum number of available objects allowed.

Specified by:

getMaxNumberOfAvailableObjects in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

max number of available objects

getNumberOfLiveObjects

public int getNumberOfLiveObjects()

Description copied from interface: RecyclerInterface

Returns the current number of live objects - these are objects that are curently in use and thus not available for recycling.

Specified by:

getNumberOfLiveObjects in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

number of live objects

getNumberOfAvailableObjects

public int getNumberOfAvailableObjects()

Description copied from interface: RecyclerInterface

Returns the current number of recyclable objects available for recycling.

Specified by:

getNumberOfAvailableObjects in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

number of available recyclable objects

getNumberOfFailedRequests

public long getNumberOfFailedRequests()

Description copied from interface: RecyclerInterface

Returns the number of failed requests.

Specified by:

getNumberOfFailedRequests in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

number of failed requests

computeLiveMemorySizeInBytes

public long computeLiveMemorySizeInBytes()

Description copied from interface: RecyclerInterface

Returns the calculated total size in bytes of live objects.

Specified by:

computeLiveMemorySizeInBytes in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

total siee of live objects in bytes

computeAvailableMemorySizeInBytes

public long computeAvailableMemorySizeInBytes()

Description copied from interface: RecyclerInterface

Returns the calculated total size in bytes of available objects.

Specified by:

computeAvailableMemorySizeInBytes in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

Returns:

calculated total size in bytes

clearReleased

public void clearReleased()

Description copied from interface: RecyclerInterface

Clears the list of available objects and frees them if the 'autofree' flag is set.

Specified by:

clearReleased in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

clearLive

public void clearLive()

Description copied from interface: RecyclerInterface

Clears the list of live objects and frees them if the 'autofree' flag is set

Specified by:

clearLive in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>

free

public void free()

Description copied from interface: Freeable

Free this object, which means that the underlying ressources are released.

Specified by:

free in interface Freeable

isFree

public boolean isFree()

Description copied from interface: Freeable

Returns true if the object has been freed, which usually means that the underlying ressources are not longer available.

Specified by:

isFree in interface Freeable

Returns:

true if free

printDebugInfo

public void printDebugInfo()

BELOW ARE DEBUG METHODS:

Specified by:

printDebugInfo in interface RecyclerInterface<R extends RecyclableInterface<R,P>,P extends RecyclerRequestInterface>