Skip to content

FakeWeakRef

@ExperimentalWeakApi
class FakeWeakRef<T>(value: T) : WeakRef<T>

Fake implementation of WeakRef.

Instead of being freed by the garbage-collector, this implementation is only freed when clear is called.

Use this implementation to help trigger edge cases in algorithms that use weak references.

Constructors

FakeWeakRef

constructor(value: T)

Functions

clear

fun clear()

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isEmpty

Checks whether this weak reference has been cleared.

isNotEmpty

Checks whether this weak reference still contains some data.

read

open override fun read(): T?

Attempts to read the value held by this reference.

If the value was garbage-collected, which may happen at any time, this accessor returns null.

One should not assume any additional behavior. In particular, the value may continue to be returned long after it has become unreachable from anywhere else in the program, or disappear sooner than one expected.

Native limitations

On Kotlin Native, values can only be freed by the GC in a different frame than the one they were created in. This means that if you call read within the body of a function, the weak reference cannot be cleared anymore until the end of the function.

Be careful of this limitation when using weak references inside a single expensive function.

To learn more, follow KT-79985.

See also

  • isEmpty: Test if the reference has been cleared.

toString

open override fun toString(): String