Package net.groboclown.retval.monitor

Class DebugObservedMonitor<T>

java.lang.Object

net.groboclown.retval.monitor.DebugObservedMonitor<T>

All Implemented Interfaces:

ObservedMonitor<T>

public class DebugObservedMonitor<T>
extends java.lang.Object
implements ObservedMonitor<T>

Maintains information about objects that need to be checked in a phantom reference cleaner.

Nested Class Summary

Nested classes/interfaces inherited from interface net.groboclown.retval.monitor.ObservedMonitor

ObservedMonitor.Listener

Constructor Summary

Constructors

Constructor	Description
DebugObservedMonitor(java.lang.String name, NotCompletedListener listener)	Create a new monitor instance.

Method Summary

Modifier and Type	Method	Description
boolean	isTraceEnabled()	Is tracing enabled? If not enabled, then more memory efficient versions of objects may be used.
ObservedMonitor.Listener	registerInstance(T instance)	Register a new observable object with the monitor.

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugObservedMonitor

public DebugObservedMonitor(@Nonnull
                            java.lang.String name,
                            @Nonnull
                            NotCompletedListener listener)

Create a new monitor instance.

Provided for eventual migration to generic monitor creation.

Parameters:

listener - listener for when not-completed states are detected.

name - name of the type being monitored

Method Detail

registerInstance

@Nonnull
public ObservedMonitor.Listener registerInstance(@Nonnull
                                                 T instance)

Description copied from interface: ObservedMonitor

Register a new observable object with the monitor. The returned value must be immutable in all but unit test environments.

Specified by:

registerInstance in interface ObservedMonitor<T>

Parameters:

instance - instance to register

Returns:

a callback listener for when the close action occurs.

isTraceEnabled

public boolean isTraceEnabled()

Description copied from interface: ObservedMonitor

Is tracing enabled? If not enabled, then more memory efficient versions of objects may be used.

Specified by:

isTraceEnabled in interface ObservedMonitor<T>

Returns:

true if close tracing is enabled, false otherwise.