com.att.inno.env.util

Class Pool.Pooled<T>

java.lang.Object

com.att.inno.env.util.Pool.Pooled<T>

Type Parameters:

T -

Enclosing class:

Pool<T>

public static class Pool.Pooled<T>
extends Object

The "Pooled" class is the transient class that wraps the actual Object T for API use/ It gives the ability to return ("done()", or "toss()") the Object to the Pool when processing is finished. For Safety, i.e. to avoid memory leaks and invalid Object States, there is a "finalize" method. It is strictly for when coder forgets to return the object, or perhaps hasn't covered the case during Exceptions or Runtime Exceptions with finally (preferred). This should not be considered normal procedure, as finalize() is called at an undetermined time during garbage collection, and is thus rather useless for a Pool. However, we don't want Coding Mistakes to put the whole program in an invalid state, so if something happened such that "done()" or "toss()" were not called, the resource is still cleaned up as well as possible.

Field Summary

Fields

Modifier and Type	Field and Description
T	content
protected LogTarget	logTarget

Constructor Summary

Constructors

Constructor and Description
Pooled(T t, Pool<T> pool, LogTarget logTarget) Create the Wrapping Object Pooled.

Method Summary

Modifier and Type	Method and Description
void	done() This is the key API for the Pool, as calling "done()" offers this object back to the Pool for reuse.
protected void	finalize() Just in case someone neglected to offer back object...
void	toss() The user of the Object may discover that the Object t is no longer in a valid state.

Methods inherited from class java.lang.Object

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

Field Detail

content

public final T content

logTarget

protected LogTarget logTarget

Constructor Detail

Pooled

public Pooled(T t,
              Pool<T> pool,
              LogTarget logTarget)

Create the Wrapping Object Pooled.

Parameters:

t -

pool -

logTarget -

Method Detail

done

public void done()

This is the key API for the Pool, as calling "done()" offers this object back to the Pool for reuse. Do not use the Pooled object again after calling "done()".

toss

public void toss()

The user of the Object may discover that the Object t is no longer in a valid state. Don't put Garbage back in the Refrigerator... Toss it, if it's no longer valid. toss() is also used for draining the Pool, etc. toss() will attempt to destroy the Object by using the Creator Interface.

finalize

protected void finalize()
                 throws Throwable

Just in case someone neglected to offer back object... Do not rely on this, as there is no specific time when finalize is called, which rather defeats the purpose of a Pool.

Overrides:

finalize in class Object

Throws:

Throwable