Skip to content
🤔 Documentation issue? Report it

//leakcanary/leakcanary/KeyedWeakReference

KeyedWeakReference

class KeyedWeakReference(referent: Any, val key: String, val description: String, val watchUptimeMillis: Long, referenceQueue: ReferenceQueue<Any>) : WeakReference<Any>

A weak reference used by ObjectWatcher to determine which objects become weakly reachable and which don’t. ObjectWatcher uses key to keep track of KeyedWeakReference instances that haven’t made it into the associated ReferenceQueue yet.

heapDumpUptimeMillis should be set with the current time from Clock.uptimeMillis right before dumping the heap, so that we can later determine how long an object was retained.

Constructors

KeyedWeakReference fun KeyedWeakReference(referent: Any, key: String, description: String, watchUptimeMillis: Long, referenceQueue: ReferenceQueue<Any>)

Types

Name Summary
Companion object Companion

Functions

Name Summary
clear open override fun clear()
enqueue open fun enqueue(): Boolean
get open fun get(): Any?
isEnqueued open fun isEnqueued(): Boolean

Properties

Name Summary
description val description: String
key val key: String
next val next: Reference<Any>
queue val queue: ReferenceQueue<in Any>
retainedUptimeMillis @Volatile
var retainedUptimeMillis: Long
Time at which the associated object (referent) was considered retained, or -1 if it hasn’t been yet.
watchUptimeMillis val watchUptimeMillis: Long