HeapObject

sealed class HeapObject

An object in the heap dump.

Types

Companion
Link copied to clipboard
object Companion
HeapClass
Link copied to clipboard
class HeapClass : HeapObject

A class in the heap dump.

HeapInstance
Link copied to clipboard
class HeapInstance : HeapObject

An instance in the heap dump.

HeapObjectArray
Link copied to clipboard
class HeapObjectArray : HeapObject

An object array in the heap dump.

HeapPrimitiveArray
Link copied to clipboard
class HeapPrimitiveArray : HeapObject

A primitive array in the heap dump.

Functions

readRecord
Link copied to clipboard
abstract fun readRecord(): HprofRecord.HeapDumpRecord.ObjectRecord

Reads and returns the underlying ObjectRecord.

Properties

asClass
Link copied to clipboard
val asClass: HeapObject.HeapClass?

This HeapObject as a HeapClass if it is one, or null otherwise

asInstance
Link copied to clipboard
val asInstance: HeapObject.HeapInstance?

This HeapObject as a HeapInstance if it is one, or null otherwise

asObjectArray
Link copied to clipboard
val asObjectArray: HeapObject.HeapObjectArray?

This HeapObject as a HeapObjectArray if it is one, or null otherwise

asPrimitiveArray
Link copied to clipboard
val asPrimitiveArray: HeapObject.HeapPrimitiveArray?

This HeapObject as a HeapPrimitiveArray if it is one, or null otherwise

graph
Link copied to clipboard
abstract val graph: HeapGraph

The graph of objects in the heap, which you can use to navigate the heap.

objectId
Link copied to clipboard
abstract val objectId: Long

The heap identifier of this object.

objectIndex
Link copied to clipboard
abstract val objectIndex: Int

An positive object index that's specific to how Shark stores objects in memory. The index starts at 0 and ends at HeapGraph.objectCount - 1. There are no gaps, every index value corresponds to an object. Classes are first, then instances, then object arrays then primitive arrays.

recordSize
Link copied to clipboard
abstract val recordSize: Int

The total byte size for the record of this object in the heap dump.

Inheritors

HeapClass
Link copied to clipboard
HeapInstance
Link copied to clipboard
HeapObjectArray
Link copied to clipboard
HeapPrimitiveArray
Link copied to clipboard