com.squareup.leakcanary

Class HeapAnalyzer

java.lang.Object

com.squareup.leakcanary.HeapAnalyzer

public final class HeapAnalyzer
extends java.lang.Object

Analyzes heap dumps generated by a RefWatcher to verify if suspected leaks are real.

Constructor Summary

Constructors

Constructor and Description
HeapAnalyzer(com.squareup.leakcanary.ExcludedRefs excludedRefs) Deprecated. Use HeapAnalyzer(ExcludedRefs, AnalyzerProgressListener, List).
HeapAnalyzer(com.squareup.leakcanary.ExcludedRefs excludedRefs, AnalyzerProgressListener listener, java.util.List<java.lang.Class<? extends com.squareup.leakcanary.Reachability.Inspector>> reachabilityInspectorClasses)

Method Summary

Modifier and Type	Method and Description
AnalysisResult	checkForLeak(java.io.File heapDumpFile, java.lang.String referenceKey) Deprecated. Use checkForLeak(File, String, boolean) instead.
AnalysisResult	checkForLeak(java.io.File heapDumpFile, java.lang.String referenceKey, boolean computeRetainedSize) Searches the heap dump for a KeyedWeakReference instance with the corresponding key, and then computes the shortest strong reference path from that instance to the GC roots.
java.util.List<TrackedReference>	findTrackedReferences(java.io.File heapDumpFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

HeapAnalyzer

@Deprecated
public HeapAnalyzer(@NonNull
                                com.squareup.leakcanary.ExcludedRefs excludedRefs)

Deprecated. Use HeapAnalyzer(ExcludedRefs, AnalyzerProgressListener, List).

HeapAnalyzer

public HeapAnalyzer(@NonNull
                    com.squareup.leakcanary.ExcludedRefs excludedRefs,
                    @NonNull
                    AnalyzerProgressListener listener,
                    @NonNull
                    java.util.List<java.lang.Class<? extends com.squareup.leakcanary.Reachability.Inspector>> reachabilityInspectorClasses)

Method Detail

findTrackedReferences

@NonNull
public java.util.List<TrackedReference> findTrackedReferences(@NonNull
                                                                       java.io.File heapDumpFile)

checkForLeak

@Deprecated
 @NonNull
public AnalysisResult checkForLeak(@NonNull
                                                         java.io.File heapDumpFile,
                                                         @NonNull
                                                         java.lang.String referenceKey)

Deprecated. Use checkForLeak(File, String, boolean) instead.

Calls checkForLeak(File, String, boolean) with computeRetainedSize set to true.

checkForLeak

@NonNull
public AnalysisResult checkForLeak(@NonNull
                                            java.io.File heapDumpFile,
                                            @NonNull
                                            java.lang.String referenceKey,
                                            boolean computeRetainedSize)

Searches the heap dump for a KeyedWeakReference instance with the corresponding key, and then computes the shortest strong reference path from that instance to the GC roots.