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)
static RefWatcher	install(android.app.Application application) Creates a RefWatcher that works out of the box, and starts watching activity references (on ICS+).
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, HeapDump heapDump, AnalysisResult result, boolean detailed) Returns a string representation of the result of a heap analysis.
static AndroidRefWatcherBuilder	refWatcher(android.content.Context context) Builder to create a customized RefWatcher with appropriate Android defaults.
static void	setDisplayLeakActivityDirectoryProvider(LeakDirectoryProvider leakDirectoryProvider) If you build a RefWatcher with a AndroidHeapDumper that has a custom LeakDirectoryProvider, then you should also call this method to make sure the activity in charge of displaying leaks can find those on the file system.

Methods inherited from class java.lang.Object

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

Method Detail

install

public static RefWatcher install(android.app.Application application)

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

refWatcher

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

Builder to create a customized RefWatcher with appropriate Android defaults.

enableDisplayLeakActivity

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

setDisplayLeakActivityDirectoryProvider

public static void setDisplayLeakActivityDirectoryProvider(LeakDirectoryProvider leakDirectoryProvider)

If you build a RefWatcher with a AndroidHeapDumper that has a custom LeakDirectoryProvider, then you should also call this method to make sure the activity in charge of displaying leaks can find those on the file system.

leakInfo

public static java.lang.String leakInfo(android.content.Context context,
                                        HeapDump heapDump,
                                        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.