com.squareup.leakcanary

Class LeakCanary

java.lang.Object

com.squareup.leakcanary.LeakCanary

public final class LeakCanary
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	enableDisplayLeakActivity(android.content.Context context) Blocking inter process call that enables the DisplayLeakActivity.
static com.squareup.leakcanary.RefWatcher	install(android.app.Application application) Creates a RefWatcher that works out of the box, and starts watching activity references (on ICS+).
static com.squareup.leakcanary.RefWatcher	installedRefWatcher()
static boolean	isInAnalyzerProcess(android.content.Context context) Whether the current process is the process running the HeapAnalyzerService, which is a different process than the normal app process.
static java.lang.String	leakInfo(android.content.Context context, com.squareup.leakcanary.HeapDump heapDump, com.squareup.leakcanary.AnalysisResult result, boolean detailed) Returns a string representation of the result of a heap analysis.
static AndroidRefWatcherBuilder	refWatcher(android.content.Context context)
static void	setDisplayLeakActivityDirectoryProvider(LeakDirectoryProvider leakDirectoryProvider) Deprecated. Use setLeakDirectoryProvider(LeakDirectoryProvider) instead.
static void	setLeakDirectoryProvider(LeakDirectoryProvider leakDirectoryProvider) Used to customize the location for the storage of heap dumps.

Methods inherited from class java.lang.Object

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

Method Detail

install

public static com.squareup.leakcanary.RefWatcher install(android.app.Application application)

Creates a RefWatcher that works out of the box, and starts watching activity references (on ICS+).

installedRefWatcher

public static com.squareup.leakcanary.RefWatcher installedRefWatcher()

Returns:

the RefWatcher installed via AndroidRefWatcherBuilder.buildAndInstall().

refWatcher

public static AndroidRefWatcherBuilder refWatcher(android.content.Context context)

enableDisplayLeakActivity

public static void enableDisplayLeakActivity(android.content.Context context)

Blocking inter process call that enables the DisplayLeakActivity. When you first install the app, DisplayLeakActivity is disabled by default and will only be enabled once a potential leak has been found and the analysis starts. You can call this method to enable DisplayLeakActivity before any potential leak has been detected.

setDisplayLeakActivityDirectoryProvider

@Deprecated
public static void setDisplayLeakActivityDirectoryProvider(LeakDirectoryProvider leakDirectoryProvider)

Deprecated. Use setLeakDirectoryProvider(LeakDirectoryProvider) instead.

setLeakDirectoryProvider

public static void setLeakDirectoryProvider(LeakDirectoryProvider leakDirectoryProvider)

Used to customize the location for the storage of heap dumps. The default implementation is DefaultLeakDirectoryProvider.

Throws:

java.lang.IllegalStateException - if a LeakDirectoryProvider has already been set, including if the default has been automatically set when installing the ref watcher.

leakInfo

public static java.lang.String leakInfo(android.content.Context context,
                                        com.squareup.leakcanary.HeapDump heapDump,
                                        com.squareup.leakcanary.AnalysisResult result,
                                        boolean detailed)

Returns a string representation of the result of a heap analysis.

isInAnalyzerProcess

public static boolean isInAnalyzerProcess(android.content.Context context)

Whether the current process is the process running the HeapAnalyzerService, which is a different process than the normal app process.