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

Method Summary

Modifier and Type	Method and Description
void	clearWatchedReferences() LeakCanary will stop watching any references that were passed to watch(Object, String) so far.
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

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 WatchExecutor this RefWatcher has been constructed with.

Parameters:

referenceName - An logical identifier for the watched object.

clearWatchedReferences

public void clearWatchedReferences()

LeakCanary will stop watching any references that were passed to watch(Object, String) so far.