org.fusesource.hawtdispatch

Class BaseRetained

java.lang.Object

org.fusesource.hawtdispatch.BaseRetained

All Implemented Interfaces:

Retained

public class BaseRetained
extends java.lang.Object
implements Retained

Base class that implements the Retained interface.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.util.HashSet<java.lang.String>	CALLERS
private Task	disposer
private static int	MAX_TRACES
private java.util.concurrent.atomic.AtomicInteger	retained
private static boolean	TRACE
private java.util.ArrayList<java.lang.String>	traces

Constructor Summary

Constructors

Constructor and Description
BaseRetained()

Method Summary

Modifier and Type	Method and Description
protected void	assertRetained() Subclasses can use this method to validate that the object has not yet been released.
protected void	dispose() This method will be called once the release retained reaches zero.
Task	getDisposer()
void	release() Decrement the reference count of this object.
protected void	release(int n) Decrements the reference count by n.
void	retain() Increment the reference count of this object.
int	retained()
void	setDisposer(java.lang.Runnable disposer) Adds a disposer runnable that is executed once the object is disposed.
void	setDisposer(Task disposer) Adds a disposer runnable that is executed once the object is disposed.
private static java.lang.String	squash(java.lang.StackTraceElement[] st)
private void	trace(java.lang.String action, int counter)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TRACES

private static final int MAX_TRACES

TRACE

private static final boolean TRACE

retained

private final java.util.concurrent.atomic.AtomicInteger retained

disposer

private volatile Task disposer

traces

private final java.util.ArrayList<java.lang.String> traces

CALLERS

static java.util.HashSet<java.lang.String> CALLERS

Constructor Detail

BaseRetained

public BaseRetained()

Method Detail

setDisposer

public final void setDisposer(java.lang.Runnable disposer)

Adds a disposer runnable that is executed once the object is disposed.

A dispatch object's disposer runnable will be invoked on the object's target queue once the object's retain counter reaches zero. This disposer may be used by the application to release any resources associated with the object.

Parameters:

disposer -

setDisposer

public final void setDisposer(Task disposer)

Adds a disposer runnable that is executed once the object is disposed.

A dispatch object's disposer runnable will be invoked on the object's target queue once the object's retain counter reaches zero. This disposer may be used by the application to release any resources associated with the object.

Parameters:

disposer -

getDisposer

public final Task getDisposer()

retain

public final void retain()

Increment the reference count of this object.

Calls to retain() must be balanced with calls to release().

Specified by:

retain in interface Retained

release

public final void release()

Decrement the reference count of this object.

An object is asynchronously disposed once all references are released. Using a disposed object will cause undefined errors. The system does not guarantee that a given client is the last or only reference to a given object.

Specified by:

release in interface Retained

release

protected final void release(int n)

Decrements the reference count by n.

An object is asynchronously disposed once all references are released. Using a disposed object will cause undefined errors. The system does not guarantee that a given client is the last or only reference to a given object.

Parameters:

n -

assertRetained

protected final void assertRetained()

Subclasses can use this method to validate that the object has not yet been released. it will throw an IllegalStateException if it has been released.

Throws:

java.lang.IllegalStateException - if the object has been released.

retained

public final int retained()

Specified by:

retained in interface Retained

Returns:

the retained counter

dispose

protected void dispose()

This method will be called once the release retained reaches zero. It causes the set disposer runnabled to be executed if not null.

Subclasses should override if they want to implement a custom disposing action in addition to the actions performed by the disposer object.

trace

private final void trace(java.lang.String action,
                         int counter)

squash

private static java.lang.String squash(java.lang.StackTraceElement[] st)