A B C D E F G H I L M N R S T V W

A

alwaysExclude() - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

alwaysExclude - Variable in class com.squareup.leakcanary.Exclusion

analyze(HeapDump) - Method in interface com.squareup.leakcanary.HeapDump.Listener

B

build() - Method in interface com.squareup.leakcanary.ExcludedRefs.Builder

build() - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

build() - Method in class com.squareup.leakcanary.HeapDump.Builder

build() - Method in class com.squareup.leakcanary.RefWatcherBuilder

Creates a RefWatcher.

builder() - Static method in class com.squareup.leakcanary.ExcludedRefs

builder() - Static method in class com.squareup.leakcanary.HeapDump

buildUpon() - Method in class com.squareup.leakcanary.HeapDump

C

classHierarchy - Variable in class com.squareup.leakcanary.LeakTraceElement

Class hierarchy for that object.

className - Variable in class com.squareup.leakcanary.LeakTraceElement

classNames - Variable in class com.squareup.leakcanary.ExcludedRefs

clazz(String) - Method in interface com.squareup.leakcanary.ExcludedRefs.Builder

clazz(String) - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

Ignores all fields and static fields of all subclasses of the provided class name.

clearWatchedReferences() - Method in class com.squareup.leakcanary.RefWatcher

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

com.squareup.leakcanary - package com.squareup.leakcanary

computeRetainedHeapSize(boolean) - Method in class com.squareup.leakcanary.HeapDump.Builder

computeRetainedHeapSize - Variable in class com.squareup.leakcanary.HeapDump

computeRetainedHeapSize(boolean) - Method in class com.squareup.leakcanary.RefWatcherBuilder

Whether LeakCanary should compute the retained heap size when a leak is detected.

D

DebuggerControl - Interface in com.squareup.leakcanary

Gives the opportunity to skip checking if a reference is gone when the debugger is connected.

debuggerControl(DebuggerControl) - Method in class com.squareup.leakcanary.RefWatcherBuilder

DEFAULT - Static variable in interface com.squareup.leakcanary.GcTrigger

defaultDebuggerControl() - Method in class com.squareup.leakcanary.RefWatcherBuilder

defaultExcludedRefs() - Method in class com.squareup.leakcanary.RefWatcherBuilder

defaultGcTrigger() - Method in class com.squareup.leakcanary.RefWatcherBuilder

defaultHeapDumper() - Method in class com.squareup.leakcanary.RefWatcherBuilder

defaultHeapDumpListener() - Method in class com.squareup.leakcanary.RefWatcherBuilder

defaultReachabilityInspectorClasses() - Method in class com.squareup.leakcanary.RefWatcherBuilder

defaultWatchExecutor() - Method in class com.squareup.leakcanary.RefWatcherBuilder

DISABLED - Static variable in class com.squareup.leakcanary.RefWatcher

dumpHeap() - Method in interface com.squareup.leakcanary.HeapDumper

E

ExcludedRefs - Class in com.squareup.leakcanary

Prevents specific references from being taken into account when computing the shortest strong reference path from a suspected leaking instance to the GC roots.

excludedRefs(ExcludedRefs) - Method in class com.squareup.leakcanary.HeapDump.Builder

excludedRefs - Variable in class com.squareup.leakcanary.HeapDump

References that should be ignored when analyzing this heap dump.

excludedRefs(ExcludedRefs) - Method in class com.squareup.leakcanary.RefWatcherBuilder

ExcludedRefs.Builder - Interface in com.squareup.leakcanary

ExcludedRefs.BuilderWithParams - Class in com.squareup.leakcanary

Exclusion - Class in com.squareup.leakcanary

exclusion - Variable in class com.squareup.leakcanary.LeakTraceElement

If not null, there was no path that could exclude this element.

execute(Retryable) - Method in interface com.squareup.leakcanary.WatchExecutor

expectedReachability(LeakTraceElement) - Method in interface com.squareup.leakcanary.Reachability.Inspector

extra - Variable in class com.squareup.leakcanary.LeakTraceElement

Additional information, may be null.

F

fieldNameByClassName - Variable in class com.squareup.leakcanary.ExcludedRefs

fieldReferences - Variable in class com.squareup.leakcanary.LeakTraceElement

List of all fields (member and static) for that object.

fields - Variable in class com.squareup.leakcanary.LeakTraceElement

Deprecated.

Use LeakTraceElement.fieldReferences instead.

G

gcDurationMs(long) - Method in class com.squareup.leakcanary.HeapDump.Builder

gcDurationMs - Variable in class com.squareup.leakcanary.HeapDump

GcTrigger - Interface in com.squareup.leakcanary

Called when a watched reference is expected to be weakly reachable, but hasn't been enqueued in the reference queue yet.

gcTrigger(GcTrigger) - Method in class com.squareup.leakcanary.RefWatcherBuilder

getDisplayName() - Method in class com.squareup.leakcanary.LeakReference

getFieldReferenceValue(String) - Method in class com.squareup.leakcanary.LeakTraceElement

Returns the string value of the first field reference that has the provided referenceName, or null if no field reference with that name was found.

getSimpleClassName() - Method in class com.squareup.leakcanary.LeakTraceElement

Returns LeakTraceElement.className without the package.

H

HeapDump - Class in com.squareup.leakcanary

Data structure holding information about a heap dump.

HeapDump(File, String, String, ExcludedRefs, long, long, long) - Constructor for class com.squareup.leakcanary.HeapDump

Deprecated.

Use HeapDump.HeapDump(Builder) instead.

HeapDump.Builder - Class in com.squareup.leakcanary

HeapDump.Listener - Interface in com.squareup.leakcanary

Receives a heap dump to analyze.

heapDumpDurationMs(long) - Method in class com.squareup.leakcanary.HeapDump.Builder

heapDumpDurationMs - Variable in class com.squareup.leakcanary.HeapDump

HeapDumper - Interface in com.squareup.leakcanary

Dumps the heap into a file.

heapDumper(HeapDumper) - Method in class com.squareup.leakcanary.RefWatcherBuilder

heapDumpFile(File) - Method in class com.squareup.leakcanary.HeapDump.Builder

heapDumpFile - Variable in class com.squareup.leakcanary.HeapDump

The heap dump file, which you might want to upload somewhere.

heapDumpListener(HeapDump.Listener) - Method in class com.squareup.leakcanary.RefWatcherBuilder

holder - Variable in class com.squareup.leakcanary.LeakTraceElement

I

instanceField(String, String) - Method in interface com.squareup.leakcanary.ExcludedRefs.Builder

instanceField(String, String) - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

isDebuggerAttached() - Method in interface com.squareup.leakcanary.DebuggerControl

isDisabled() - Method in class com.squareup.leakcanary.RefWatcherBuilder

isInstanceOf(Class<?>) - Method in class com.squareup.leakcanary.LeakTraceElement

isInstanceOf(String) - Method in class com.squareup.leakcanary.LeakTraceElement

Returns true if this element is an instance of the provided class name, false otherwise.

L

LeakReference - Class in com.squareup.leakcanary

A single field in a LeakTraceElement.

LeakReference(LeakTraceElement.Type, String, String) - Constructor for class com.squareup.leakcanary.LeakReference

LeakTraceElement - Class in com.squareup.leakcanary

Represents one reference in the chain of references that holds a leaking object in memory.

LeakTraceElement.Holder - Enum in com.squareup.leakcanary

LeakTraceElement.Type - Enum in com.squareup.leakcanary

M

matching - Variable in class com.squareup.leakcanary.Exclusion

N

name - Variable in class com.squareup.leakcanary.Exclusion

name - Variable in class com.squareup.leakcanary.LeakReference

named(String) - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

NONE - Static variable in interface com.squareup.leakcanary.DebuggerControl

NONE - Static variable in interface com.squareup.leakcanary.HeapDump.Listener

NONE - Static variable in interface com.squareup.leakcanary.HeapDumper

NONE - Static variable in interface com.squareup.leakcanary.WatchExecutor

R

Reachability - Enum in com.squareup.leakcanary

Result returned by Reachability.Inspector.expectedReachability(LeakTraceElement).

Reachability.Inspector - Interface in com.squareup.leakcanary

Evaluates whether a LeakTraceElement should be reachable or not.

reachabilityInspectorClasses(List<Class<? extends Reachability.Inspector>>) - Method in class com.squareup.leakcanary.HeapDump.Builder

reachabilityInspectorClasses - Variable in class com.squareup.leakcanary.HeapDump

reason(String) - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

reason - Variable in class com.squareup.leakcanary.Exclusion

reference - Variable in class com.squareup.leakcanary.LeakTraceElement

Information about the reference that points to the next LeakTraceElement in the leak chain.

referenceKey(String) - Method in class com.squareup.leakcanary.HeapDump.Builder

referenceKey - Variable in class com.squareup.leakcanary.HeapDump

Key associated to the KeyedWeakReference used to detect the memory leak.

referenceName(String) - Method in class com.squareup.leakcanary.HeapDump.Builder

referenceName - Variable in class com.squareup.leakcanary.HeapDump

User defined name to help identify the leaking instance.

referenceName - Variable in class com.squareup.leakcanary.LeakTraceElement

Deprecated.

Use LeakTraceElement.reference and LeakReference.getDisplayName() instead. Null if this is the last element in the leak trace, ie the leaking object.

RefWatcher - Class in com.squareup.leakcanary

Watches references that should become weakly reachable.

RefWatcherBuilder<T extends RefWatcherBuilder<T>> - Class in com.squareup.leakcanary

Responsible for building RefWatcher instances.

RefWatcherBuilder() - Constructor for class com.squareup.leakcanary.RefWatcherBuilder

RETRY_LATER - Static variable in interface com.squareup.leakcanary.HeapDumper

Retryable - Interface in com.squareup.leakcanary

A unit of work that can be retried later.

Retryable.Result - Enum in com.squareup.leakcanary

run() - Method in interface com.squareup.leakcanary.Retryable

runGc() - Method in interface com.squareup.leakcanary.GcTrigger

S

self() - Method in class com.squareup.leakcanary.RefWatcherBuilder

staticField(String, String) - Method in interface com.squareup.leakcanary.ExcludedRefs.Builder

staticField(String, String) - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

staticFieldNameByClassName - Variable in class com.squareup.leakcanary.ExcludedRefs

stethoscopeClasses(List<Class<? extends Reachability.Inspector>>) - Method in class com.squareup.leakcanary.RefWatcherBuilder

T

thread(String) - Method in interface com.squareup.leakcanary.ExcludedRefs.Builder

thread(String) - Method in class com.squareup.leakcanary.ExcludedRefs.BuilderWithParams

threadNames - Variable in class com.squareup.leakcanary.ExcludedRefs

toDetailedString() - Method in class com.squareup.leakcanary.LeakTraceElement

toString() - Method in class com.squareup.leakcanary.ExcludedRefs

toString() - Method in class com.squareup.leakcanary.LeakReference

toString() - Method in class com.squareup.leakcanary.LeakTraceElement

toString(boolean) - Method in class com.squareup.leakcanary.LeakTraceElement

type - Variable in class com.squareup.leakcanary.LeakReference

type - Variable in class com.squareup.leakcanary.LeakTraceElement

Deprecated.

Use LeakTraceElement.reference and LeakReference.type instead. Null if this is the last element in the leak trace, ie the leaking object.

V

value - Variable in class com.squareup.leakcanary.LeakReference

valueOf(String) - Static method in enum com.squareup.leakcanary.LeakTraceElement.Holder

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.squareup.leakcanary.LeakTraceElement.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.squareup.leakcanary.Reachability

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.squareup.leakcanary.Retryable.Result

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.squareup.leakcanary.LeakTraceElement.Holder

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.squareup.leakcanary.LeakTraceElement.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.squareup.leakcanary.Reachability

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.squareup.leakcanary.Retryable.Result

Returns an array containing the constants of this enum type, in the order they are declared.

W

watch(Object) - Method in class com.squareup.leakcanary.RefWatcher

Identical to RefWatcher.watch(Object, String) with an empty string reference name.

watch(Object, String) - Method in class com.squareup.leakcanary.RefWatcher

Watches the provided references and checks if it can be GCed.

watchDurationMs(long) - Method in class com.squareup.leakcanary.HeapDump.Builder

watchDurationMs - Variable in class com.squareup.leakcanary.HeapDump

Time from the request to watch the reference until the GC was triggered.

watchExecutor(WatchExecutor) - Method in class com.squareup.leakcanary.RefWatcherBuilder

WatchExecutor - Interface in com.squareup.leakcanary

A WatchExecutor is in charge of executing a Retryable in the future, and retry later if needed.

A B C D E F G H I L M N R S T V W