com.squareup.leakcanary

Class AndroidRefWatcherBuilder

java.lang.Object

<any>

com.squareup.leakcanary.AndroidRefWatcherBuilder

public final class AndroidRefWatcherBuilder
extends <any>

A RefWatcherBuilder with appropriate Android defaults.

Method Summary

Modifier and Type	Method and Description
RefWatcher	buildAndInstall() Creates a RefWatcher instance and starts watching activity references (on ICS+).
protected DebuggerControl	defaultDebuggerControl()
protected ExcludedRefs	defaultExcludedRefs()
protected HeapDumper	defaultHeapDumper()
protected HeapDump.Listener	defaultHeapDumpListener()
protected 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	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.

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 #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 #watchExecutor(WatchExecutor).

maxStoredHeapDumps

public AndroidRefWatcherBuilder maxStoredHeapDumps(int maxStoredHeapDumps)

Sets the maximum number of heap dumps stored. This overrides any call to #heapDumper(HeapDumper) as well as any call to LeakCanary.setDisplayLeakActivityDirectoryProvider(LeakDirectoryProvider))}

Throws:

java.lang.IllegalArgumentException - if maxStoredHeapDumps < 1.

buildAndInstall

public RefWatcher buildAndInstall()

Creates a RefWatcher instance and starts watching activity references (on ICS+).

isDisabled

protected boolean isDisabled()

defaultHeapDumper

protected HeapDumper defaultHeapDumper()

defaultDebuggerControl

protected DebuggerControl defaultDebuggerControl()

defaultHeapDumpListener

protected HeapDump.Listener defaultHeapDumpListener()

defaultExcludedRefs

protected ExcludedRefs defaultExcludedRefs()

defaultWatchExecutor

protected WatchExecutor defaultWatchExecutor()