com.squareup.leakcanary

Class RefWatcher

java.lang.Object

com.squareup.leakcanary.RefWatcher

public final class RefWatcher
extends java.lang.Object

Watches references that should become weakly reachable. When the RefWatcher detects that a reference might not be weakly reachable when it should, it triggers the HeapDumper.

This class is thread-safe: you can call watch(Object) from any thread.

Field Summary

Fields

Modifier and Type	Field and Description
static RefWatcher	DISABLED

Constructor Summary

Constructors

Constructor and Description
RefWatcher(java.util.concurrent.Executor watchExecutor, DebuggerControl debuggerControl, GcTrigger gcTrigger, HeapDumper heapDumper, HeapDump.Listener heapdumpListener, ExcludedRefs excludedRefs)

Method Summary

Methods

Modifier and Type	Method and Description
void	watch(java.lang.Object watchedReference) Identical to watch(Object, String) with an empty string reference name.
void	watch(java.lang.Object watchedReference, java.lang.String referenceName) Watches the provided references and checks if it can be GCed.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLED

public static final RefWatcher DISABLED

Constructor Detail

RefWatcher

public RefWatcher(java.util.concurrent.Executor watchExecutor,
          DebuggerControl debuggerControl,
          GcTrigger gcTrigger,
          HeapDumper heapDumper,
          HeapDump.Listener heapdumpListener,
          ExcludedRefs excludedRefs)

Method Detail

watch

public void watch(java.lang.Object watchedReference)

Identical to watch(Object, String) with an empty string reference name.

See Also:

watch(Object, String)

watch

public void watch(java.lang.Object watchedReference,
         java.lang.String referenceName)

Watches the provided references and checks if it can be GCed. This method is non blocking, the check is done on the Executor this RefWatcher has been constructed with.

Parameters:

referenceName - An logical identifier for the watched object.