Skip to content
🤔 Documentation issue? Report it

//leakcanary-repo/shark/Reference

Reference

[jvm]\ data class Reference(val valueObjectId: Long, val isLowPriority: Boolean, val isLeafObject: Boolean = false, val lazyDetailsResolver: Reference.LazyDetails.Resolver)

TODO Review as public API.

Constructors

Reference [jvm]
constructor(valueObjectId: Long, isLowPriority: Boolean, isLeafObject: Boolean = false, lazyDetailsResolver: Reference.LazyDetails.Resolver)

Types

Name Summary
LazyDetails [jvm]
class LazyDetails(val name: String, val locationClassObjectId: Long, val locationType: ReferenceLocationType, val matchedLibraryLeak: LibraryLeakReferenceMatcher?, val isVirtual: Boolean)

Properties

Name Summary
isLeafObject [jvm]
val isLeafObject: Boolean = false
Whether this object should be treated as a leaf / sink object with no outgoing references (regardless of its actual content).
isLowPriority [jvm]
val isLowPriority: Boolean
Low priority references are references that should be explored after any non low priority reference has been explored. This ensures that such references are not on the shortest best path if there is any other path that doesn’t include any low priority reference.
lazyDetailsResolver [jvm]
val lazyDetailsResolver: Reference.LazyDetails.Resolver
valueObjectId [jvm]
val valueObjectId: Long
The value of the reference, i.e. the object the reference is pointing to.