Package io.deephaven.engine.util.reference

Enum Class CleanupReferenceProcessorInstance

java.lang.Object

java.lang.Enum<CleanupReferenceProcessorInstance>

io.deephaven.engine.util.reference.CleanupReferenceProcessorInstance

All Implemented Interfaces:

Serializable, Comparable<CleanupReferenceProcessorInstance>, java.lang.constant.Constable

public enum CleanupReferenceProcessorInstance
extends Enum<CleanupReferenceProcessorInstance>

Dedicated ReferenceQueue suppliers for various engine purposes.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LIVENESS

Method Summary

Modifier and Type	Method	Description
final <RT> ReferenceQueue<RT>	getReferenceQueue()
final <T> CleanupReference<T>	registerPhantom(T referent, @NotNull Runnable action)	Registers a referent and a cleaning action to run when the referent becomes phantom reachable.
static void	resetAllForUnitTests()
static CleanupReferenceProcessorInstance	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CleanupReferenceProcessorInstance[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LIVENESS

public static final CleanupReferenceProcessorInstance LIVENESS

Method Details

values

public static CleanupReferenceProcessorInstance[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CleanupReferenceProcessorInstance valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getReferenceQueue

public final <RT> ReferenceQueue<RT> getReferenceQueue()

registerPhantom

public final <T> CleanupReference<T> registerPhantom(@NotNull
 T referent,
 @NotNull
 @NotNull Runnable action)

Registers a referent and a cleaning action to run when the referent becomes phantom reachable. The returned CleanupReference is retained by this processor, ensuring it will not be garbage-collected before cleanup occurs.

Parameters:

referent - the object to monitor

action - a Runnable to invoke when the referent becomes phantom reachable; must not hold a strong reference to the referent

Returns:

a cleanup reference instance

See Also:

• CleanupReferenceProcessor.registerPhantom(Object, Runnable)

resetAllForUnitTests

@TestUseOnly
public static void resetAllForUnitTests()