OpenJDK 1.23 · jdk.vm.ci.hotspot.Cleaner · APIdia, the JavaDoc alternative

A cleaner tracks a referent object and includes some cleanup code that is run some time after the referent object has become weakly-reachable. This is like java.lang.ref.Cleaner but with weak semantics instead of phantom. Objects referenced by this might be referenced by ResolvedJavaType which is kept alive by a WeakReference so we need equivalent reference strength.

Field Summary

Modifier and Type	Field and Description
private static Cleaner	first Head of linked list of cleaners.
private Cleaner	next Hides java.lang.ref.Reference.next. Linked list pointers.
private Cleaner	prev
private static final ReferenceQueue<Object>	queue Hides java.lang.ref.Reference.queue. The `ReferenceQueue` to which `Cleaner`s are enqueued once their referents' become unreachable.

Constructor Summary

Access	Constructor and Description
pack-priv	Cleaner(Object referent)

Method Summary

Modifier and Type	Method and Description
private static synchronized Cleaner	add(Cleaner cl)
pack-priv static void	clean() Remove the cleaners whose referents have become weakly reachable.
pack-priv abstract boolean	Returns: true if the clean up action cleared the referent of an oop handle and requires a subsequent call to `CompilerToVM#releaseClearedOopHandles()` to reclaim the resources of the handle itself doCleanup() Performs the cleanup action now that this object's referent has become weakly reachable.
private static synchronized void	remove(Cleaner cl) Removes `cl` from the linked list of cleaners.

Field Detail

first	back to summary
private static Cleaner first Head of linked list of cleaners. Annotations @NativeImageReinitialize

next	back to summary
private Cleaner next Hides java.lang.ref.Reference.next. Linked list pointers.

back to summary

private Cleaner next

Hides java.lang.ref.Reference.next.

Linked list pointers.

prev	back to summary
private Cleaner prev

queue back to summary

queue	back to summary
private static final ReferenceQueue<Object> queue Hides java.lang.ref.Reference.queue. The `ReferenceQueue` to which `Cleaner`s are enqueued once their referents' become unreachable.

private static final ReferenceQueue<Object> queue

Hides java.lang.ref.Reference.queue.

The ReferenceQueue to which Cleaners are enqueued once their referents' become unreachable.

Constructor Detail

Cleaner	back to summary
pack-priv Cleaner(Object referent)

Method Detail

add	back to summary
private static synchronized Cleaner add(Cleaner cl)

clean	back to summary
pack-priv static void clean() Remove the cleaners whose referents have become weakly reachable.

doCleanup back to summary

doCleanup	back to summary
pack-priv abstract boolean doCleanup() Performs the cleanup action now that this object's referent has become weakly reachable. Returns:boolean true if the clean up action cleared the referent of an oop handle and requires a subsequent call to `CompilerToVM#releaseClearedOopHandles()` to reclaim the resources of the handle itself

pack-priv abstract boolean doCleanup()

Performs the cleanup action now that this object's referent has become weakly reachable.

Returns:boolean: true if the clean up action cleared the referent of an oop handle and requires a subsequent call to CompilerToVM#releaseClearedOopHandles() to reclaim the resources of the handle itself