object-watcher/leakcanary/RetainedObjectTracker

RetainedObjectTracker

interface RetainedObjectTracker

Helper util for tracking retained objects.

A retained object is an object that is expected to be deleted but stays strongly reachable, preventing it from being garbage collected.

A target object is "tracked" after being reported to an associated DeletableObjectReporter or TriggeredDeletableObjectReporter.
If at any point in time that target object becomes weakly reachable, then RetainedObjectTracker will stop tracking that object.

Inheritors

ReferenceQueueRetainedObjectTracker

Functions

clearAllObjectsTracked

abstract fun clearAllObjectsTracked()

Clears weak reachability expectations for all tracked objects.

clearObjectsTrackedBefore

abstract fun clearObjectsTrackedBefore(uptime: Duration)

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

Properties

hasRetainedObjects

abstract val hasRetainedObjects: Boolean

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

hasTrackedObjects

abstract val hasTrackedObjects: Boolean

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

retainedObjectCount

abstract val retainedObjectCount: Int

Returns the number of retained objects.

trackedObjectCount

abstract val trackedObjectCount: Int

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