Skip to content
🤔 Documentation issue? Report it

//leakcanary/shark/HeapValue

HeapValue

class HeapValue(val graph: HeapGraph, val holder: ValueHolder)

Represents a value in the heap dump, which can be an object reference or a primitive type.

Constructors

HeapValue fun HeapValue(graph: HeapGraph, holder: ValueHolder)

Functions

Name Summary
readAsJavaString fun readAsJavaString(): String?
If this HeapValue if it represents a non null object reference to an instance of the String class that exists in the heap dump, returns a String instance with content that matches the string in the heap dump. Otherwise returns null.

Properties

Name Summary
asBoolean val asBoolean: Boolean?
This HeapValue as a Boolean if it represents one, or null otherwise.
asByte val asByte: Byte?
This HeapValue as a Byte if it represents one, or null otherwise.
asChar val asChar: Char?
This HeapValue as a Char if it represents one, or null otherwise.
asDouble val asDouble: Double?
This HeapValue as a Double if it represents one, or null otherwise.
asFloat val asFloat: Float?
This HeapValue as a Float if it represents one, or null otherwise.
asInt val asInt: Int?
This HeapValue as an Int if it represents one, or null otherwise.
asLong val asLong: Long?
This HeapValue as a Long if it represents one, or null otherwise.
asNonNullObjectId val asNonNullObjectId: Long?
This HeapValue as a Long if it represents a non null object reference, or null otherwise.
asObject val asObject: HeapObject?
The HeapObject referenced by this HeapValue if it represents a non null object reference, or null otherwise.
asObjectId val asObjectId: Long?
This HeapValue as a Long if it represents an object reference, or null otherwise.
asShort val asShort: Short?
This HeapValue as a Short if it represents one, or null otherwise.
graph val graph: HeapGraph
The graph of objects in the heap, which you can use to navigate the heap.
holder val holder: ValueHolder
Holds the actual value that this HeapValue represents.
isNonNullReference val isNonNullReference: Boolean
True is this HeapValue represents a non null object reference, false otherwise.
isNullReference val isNullReference: Boolean
True is this HeapValue represents a null object reference, false otherwise.

Extensions

Name Summary
heapValueAsString fun HeapValue.heapValueAsString(): String