com.neeve.util

Class UtlReferenceTracker

java.lang.Object

com.neeve.util.UtlReferenceTracker

public class UtlReferenceTracker
extends Object

Tracks references for a reference counted object.

Reference tracking is enabled as follows:

• Globally by setting the X Runtime property nv.reftracking.enabled=true
• Globally by setting the X Runtime property nv.reftracking.types=*
• On a type by type basis using nv.reftracking.types=fullclassname1[|fullclassnameN] (a list of fully qualified class names delimited by '|')

Reference tracking is very expensive and should only be enabled when debugging reference counting issues.

This class IS NOT intended to be used by end users.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UtlReferenceTracker.HasReferenceTracker Marks an object as having a reference tracker.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ENABLED True if reference tracking is globally enabled in the System.
static boolean	TYPE_TRACKING_ENABLED True if reference tracking is enabled for at least one type in the System.

Constructor Summary

Constructors

Constructor and Description
UtlReferenceTracker(Object item)

Method Summary

Methods

Modifier and Type	Method and Description
void	dump()
void	dump(StringBuilder sb)
static boolean	enabled(Class<?> type) Tests if reference tracking is enabled for the given type.
static boolean	enabled(String typeName) Tests if reference tracking is enabled for the given type.
void	onAcquire(int newCount)
void	onDispose(int newCount)
void	onInit(int initCount)
void	onUndispose(int oldCount, int initCount)
void	setAssociatedTracker(UtlReferenceTracker associatedTracker) Sets a tracker associated with this tracker, for example a parent or child tracker.

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED

public static final boolean ENABLED

True if reference tracking is globally enabled in the System.

TYPE_TRACKING_ENABLED

public static final boolean TYPE_TRACKING_ENABLED

True if reference tracking is enabled for at least one type in the System. This will always be true if ENABLED is set to true.

Constructor Detail

UtlReferenceTracker

public UtlReferenceTracker(Object item)

Method Detail

onUndispose

public final void onUndispose(int oldCount,
               int initCount)

onInit

public final void onInit(int initCount)

onAcquire

public final void onAcquire(int newCount)

onDispose

public final void onDispose(int newCount)

dump

public final void dump()

dump

public final void dump(StringBuilder sb)

setAssociatedTracker

public void setAssociatedTracker(UtlReferenceTracker associatedTracker)

Sets a tracker associated with this tracker, for example a parent or child tracker. When this tracker's history is dumped the associated history will be included.

NOTE: Cycles of associations are not currently supported and will result in an infinite dump loop.

Parameters:

associatedTracker - A tracker associated with this one.

enabled

public static boolean enabled(Class<?> type)

Tests if reference tracking is enabled for the given type.

Parameters:

type - The type to check against for reference tracking.

Returns:

True if enabled.

enabled

public static boolean enabled(String typeName)

Tests if reference tracking is enabled for the given type.

Parameters:

typeName - The type to check against for reference tracking.

Returns:

True if enabled.