com.squareup.leakcanary

Class HeapDump

java.lang.Object

com.squareup.leakcanary.HeapDump

All Implemented Interfaces:

java.io.Serializable

public final class HeapDump
extends java.lang.Object
implements java.io.Serializable

Data structure holding information about a heap dump.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeapDump.Builder
static interface	HeapDump.Listener Receives a heap dump to analyze.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	computeRetainedHeapSize
ExcludedRefs	excludedRefs References that should be ignored when analyzing this heap dump.
long	gcDurationMs
long	heapDumpDurationMs
java.io.File	heapDumpFile The heap dump file, which you might want to upload somewhere.
java.util.List<java.lang.Class<? extends Reachability.Inspector>>	reachabilityInspectorClasses
java.lang.String	referenceKey Key associated to the KeyedWeakReference used to detect the memory leak.
java.lang.String	referenceName User defined name to help identify the leaking instance.
long	watchDurationMs Time from the request to watch the reference until the GC was triggered.

Constructor Summary

Constructors

Constructor and Description
HeapDump(java.io.File heapDumpFile, java.lang.String referenceKey, java.lang.String referenceName, ExcludedRefs excludedRefs, long watchDurationMs, long gcDurationMs, long heapDumpDurationMs) Deprecated. Use HeapDump(Builder) instead.

Method Summary

Modifier and Type	Method and Description
static HeapDump.Builder	builder()
HeapDump.Builder	buildUpon()

Methods inherited from class java.lang.Object

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

Field Detail

heapDumpFile

public final java.io.File heapDumpFile

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

referenceKey

public final java.lang.String referenceKey

Key associated to the KeyedWeakReference used to detect the memory leak. When analyzing a heap dump, search for all KeyedWeakReference instances, then open the one that has its "key" field set to this value. Its "referent" field contains the leaking object. Computing the shortest path to GC roots on that leaking object should enable you to figure out the cause of the leak.

referenceName

public final java.lang.String referenceName

User defined name to help identify the leaking instance.

excludedRefs

public final ExcludedRefs excludedRefs

References that should be ignored when analyzing this heap dump.

watchDurationMs

public final long watchDurationMs

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

gcDurationMs

public final long gcDurationMs

heapDumpDurationMs

public final long heapDumpDurationMs

computeRetainedHeapSize

public final boolean computeRetainedHeapSize

reachabilityInspectorClasses

public final java.util.List<java.lang.Class<? extends Reachability.Inspector>> reachabilityInspectorClasses

Constructor Detail

HeapDump

@Deprecated
public HeapDump(java.io.File heapDumpFile,
                            java.lang.String referenceKey,
                            java.lang.String referenceName,
                            ExcludedRefs excludedRefs,
                            long watchDurationMs,
                            long gcDurationMs,
                            long heapDumpDurationMs)

Deprecated. Use HeapDump(Builder) instead.

Calls HeapDump(Builder) with computeRetainedHeapSize set to true.

Method Detail

builder

public static HeapDump.Builder builder()

buildUpon

public HeapDump.Builder buildUpon()