shark-graph / shark / HeapGraph

HeapGraph

interface HeapGraph

Enables navigation through the heap graph of objects.

Properties

Name	Summary
classCount	abstract val classCount: Int
classes	abstract val classes: Sequence<HeapObject.HeapClass> Sequence of all classes in the heap dump.
context	abstract val context: GraphContext In memory store that can be used to store objects this HeapGraph instance.
gcRoots	abstract val gcRoots: List<GcRoot> All GC roots which type matches types known to this heap graph and which point to non null references. You can retrieve the object that a GC Root points to by calling findObjectById with GcRoot.id, however you need to first check that objectExists returns true because GC roots can point to objects that don't exist in the heap dump.
identifierByteSize	abstract val identifierByteSize: Int
instanceCount	abstract val instanceCount: Int
instances	abstract val instances: Sequence<HeapObject.HeapInstance> Sequence of all instances in the heap dump.
objectArrayCount	abstract val objectArrayCount: Int
objectArrays	abstract val objectArrays: Sequence<HeapObject.HeapObjectArray> Sequence of all object arrays in the heap dump.
objectCount	abstract val objectCount: Int
objects	abstract val objects: Sequence<HeapObject> Sequence of all objects in the heap dump.
primitiveArrayCount	abstract val primitiveArrayCount: Int
primitiveArrays	abstract val primitiveArrays: Sequence<HeapObject.HeapPrimitiveArray> Sequence of all primitive arrays in the heap dump.

Functions

Name	Summary
findClassByName	abstract fun findClassByName(className: String): HeapObject.HeapClass? Returns the HeapClass corresponding to the provided className, or null if the class cannot be found.
findObjectById	abstract fun findObjectById(objectId: Long): HeapObject Returns the HeapObject corresponding to the provided objectId, and throws IllegalArgumentException otherwise.
findObjectByIdOrNull	abstract fun findObjectByIdOrNull(objectId: Long): HeapObject? Returns the HeapObject corresponding to the provided objectId or null if it cannot be found.
findObjectByIndex	abstract fun findObjectByIndex(objectIndex: Int): HeapObject Returns the HeapObject corresponding to the provided objectIndex, and throws IllegalArgumentException if objectIndex is less than 0 or more than objectCount - 1.
objectExists	abstract fun objectExists(objectId: Long): Boolean Returns true if the provided objectId exists in the heap dump.

Inheritors

Name	Summary
CloseableHeapGraph	interface CloseableHeapGraph : HeapGraph, Closeable A HeapGraph that should be closed after being used.