object-watcher/leakcanary/ReferenceQueueRetainedObjectTracker

ReferenceQueueRetainedObjectTracker

class ReferenceQueueRetainedObjectTracker(clock: UptimeClock, onObjectRetainedListener: OnObjectRetainedListener) : RetainedObjectTracker, TriggeredDeletableObjectReporter

ReferenceQueueRetainedObjectTracker can be passed objects to expectDeletionOnTriggerFor. It will create KeyedWeakReference instances that reference tracked objects, and check if those references have been cleared as expected. If not, these objects are considered retained and ReferenceQueueRetainedObjectTracker will then notify registered OnObjectRetainedListeners. ReferenceQueueRetainedObjectTracker is thread safe.

Constructors

constructor(clock: UptimeClock, onObjectRetainedListener: OnObjectRetainedListener)

Functions

clearAllObjectsTracked

open override fun clearAllObjectsTracked()

Clears all KeyedWeakReference

clearObjectsTrackedBefore

open override fun clearObjectsTrackedBefore(uptime: Duration)

Clears weak reachability expectations for objects that were created before uptime.

expectDeletionOnTriggerFor

open override fun expectDeletionOnTriggerFor(target: Any, reason: String): TriggeredDeletableObjectReporter.RetainTrigger

Start tracking the provided target object, with the expectation that it should be eligible for automatic garbage collection soon, i.e. that it should not be strongly reachable by the time RetainTrigger.markRetainedIfStronglyReachable is called on the returned RetainTrigger.

Properties

hasRetainedObjects

open override val hasRetainedObjects: Boolean

Returns true if any of the tracked objects are currently retained.

hasTrackedObjects

open override val hasTrackedObjects: Boolean

Returns true if there are any tracked objects that aren't currently weakly reachable.

retainedObjectCount

open override val retainedObjectCount: Int

Returns the number of retained objects.

retainedWeakReferences

val retainedWeakReferences: List<KeyedWeakReference>

Subset of trackedWeakReferences that have been marked as retained.

trackedObjectCount

open override val trackedObjectCount: Int

Returns the number of tracked objects that aren't weakly reachable.

trackedWeakReferences

val trackedWeakReferences: List<KeyedWeakReference>

List of KeyedWeakReference that have not been enqueued in the reference queue yet, which means their referent is most likely still strongly reachable.