com.squareup.leakcanary

Class AndroidRefWatcherBuilder

java.lang.Object

com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

com.squareup.leakcanary.AndroidRefWatcherBuilder

public final class AndroidRefWatcherBuilder
extends com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

A RefWatcherBuilder with appropriate Android defaults.

Method Summary

Modifier and Type	Method and Description
com.squareup.leakcanary.RefWatcher	buildAndInstall() Creates a RefWatcher instance and makes it available through LeakCanary.installedRefWatcher().
protected com.squareup.leakcanary.DebuggerControl	defaultDebuggerControl()
protected com.squareup.leakcanary.ExcludedRefs	defaultExcludedRefs()
protected com.squareup.leakcanary.HeapDumper	defaultHeapDumper()
protected com.squareup.leakcanary.HeapDump.Listener	defaultHeapDumpListener()
protected java.util.List<java.lang.Class<? extends com.squareup.leakcanary.Reachability.Inspector>>	defaultReachabilityInspectorClasses()
protected com.squareup.leakcanary.WatchExecutor	defaultWatchExecutor()
protected boolean	isDisabled()
AndroidRefWatcherBuilder	listenerServiceClass(java.lang.Class<? extends AbstractAnalysisResultService> listenerServiceClass) Sets a custom AbstractAnalysisResultService to listen to analysis results.
AndroidRefWatcherBuilder	maxStoredHeapDumps(int maxStoredHeapDumps) Sets the maximum number of heap dumps stored.
AndroidRefWatcherBuilder	watchActivities(boolean watchActivities) Whether we should automatically watch activities when calling buildAndInstall().
AndroidRefWatcherBuilder	watchDelay(long delay, java.util.concurrent.TimeUnit unit) Sets a custom delay for how long the RefWatcher should wait until it checks if a tracked object has been garbage collected.
AndroidRefWatcherBuilder	watchFragments(boolean watchFragments) Whether we should automatically watch fragments when calling buildAndInstall().

Methods inherited from class com.squareup.leakcanary.RefWatcherBuilder

build, computeRetainedHeapSize, debuggerControl, defaultGcTrigger, excludedRefs, gcTrigger, heapDumper, heapDumpListener, self, stethoscopeClasses, watchExecutor

Methods inherited from class java.lang.Object

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

Method Detail

listenerServiceClass

public AndroidRefWatcherBuilder listenerServiceClass(java.lang.Class<? extends AbstractAnalysisResultService> listenerServiceClass)

Sets a custom AbstractAnalysisResultService to listen to analysis results. This overrides any call to RefWatcherBuilder.heapDumpListener(HeapDump.Listener).

watchDelay

public AndroidRefWatcherBuilder watchDelay(long delay,
                                           java.util.concurrent.TimeUnit unit)

Sets a custom delay for how long the RefWatcher should wait until it checks if a tracked object has been garbage collected. This overrides any call to RefWatcherBuilder.watchExecutor(WatchExecutor).

watchActivities

public AndroidRefWatcherBuilder watchActivities(boolean watchActivities)

Whether we should automatically watch activities when calling buildAndInstall(). Default is true.

watchFragments

public AndroidRefWatcherBuilder watchFragments(boolean watchFragments)

Whether we should automatically watch fragments when calling buildAndInstall(). Default is true. When true, LeakCanary watches native fragments on Android O+ and support fragments if the leakcanary-support-fragment dependency is in the classpath.

maxStoredHeapDumps

public AndroidRefWatcherBuilder maxStoredHeapDumps(int maxStoredHeapDumps)

Sets the maximum number of heap dumps stored. This overrides any call to LeakCanary.setLeakDirectoryProvider(LeakDirectoryProvider)

Throws:

java.lang.IllegalArgumentException - if maxStoredHeapDumps < 1.

buildAndInstall

public com.squareup.leakcanary.RefWatcher buildAndInstall()

Creates a RefWatcher instance and makes it available through LeakCanary.installedRefWatcher(). Also starts watching activity references if watchActivities(boolean) was set to true.

Throws:

java.lang.UnsupportedOperationException - if called more than once per Android process.

isDisabled

protected boolean isDisabled()

Overrides:

isDisabled in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

defaultHeapDumper

protected com.squareup.leakcanary.HeapDumper defaultHeapDumper()

Overrides:

defaultHeapDumper in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

defaultDebuggerControl

protected com.squareup.leakcanary.DebuggerControl defaultDebuggerControl()

Overrides:

defaultDebuggerControl in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

defaultHeapDumpListener

protected com.squareup.leakcanary.HeapDump.Listener defaultHeapDumpListener()

Overrides:

defaultHeapDumpListener in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

defaultExcludedRefs

protected com.squareup.leakcanary.ExcludedRefs defaultExcludedRefs()

Overrides:

defaultExcludedRefs in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

defaultWatchExecutor

protected com.squareup.leakcanary.WatchExecutor defaultWatchExecutor()

Overrides:

defaultWatchExecutor in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>

defaultReachabilityInspectorClasses

protected java.util.List<java.lang.Class<? extends com.squareup.leakcanary.Reachability.Inspector>> defaultReachabilityInspectorClasses()

Overrides:

defaultReachabilityInspectorClasses in class com.squareup.leakcanary.RefWatcherBuilder<AndroidRefWatcherBuilder>