object-watcher/leakcanary

Package-level declarations

Types

DefaultDelayDeletableObjectReporter

class DefaultDelayDeletableObjectReporter(defaultDelay: Duration, delayedReporter: DelayedDeletableObjectReporter) : DeletableObjectReporter

DelayedDeletableObjectReporter

class DelayedDeletableObjectReporter(deletableObjectReporter: TriggeredDeletableObjectReporter, delayedExecutor: DelayedExecutor)

DelayedExecutor

fun interface DelayedExecutor

DeletableObjectReporter

fun interface DeletableObjectReporter

KeyedWeakReference

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

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

OnObjectRetainedListener

fun interface OnObjectRetainedListener

Listener used by ReferenceQueueRetainedObjectTracker to report retained objects.

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.

RetainedObjectTracker

interface RetainedObjectTracker

Helper util for tracking retained objects.

TrackedObjectReachability

interface TrackedObjectReachability

TriggeredDeletableObjectReporter

interface TriggeredDeletableObjectReporter

Tracks deletion of target objects, marking them retained on trigger.

fun interface UptimeClock

An interface to abstract the clock to get the system uptime.

Functions

filteringInstances

inline fun <T> DeletableObjectReporter.filteringInstances(crossinline apply: (T) -> Boolean): DeletableObjectReporter

Creates a wrapper around DeletableObjectReporter that will run any instance of T by apply to decide whether to forward to DeletableObjectReporter.expectDeletionFor calls. Objects that do not extend T will always be forwarded.