org.apache.flink.util

Enum JavaGcCleanerWrapper

java.lang.Object

java.lang.Enum<JavaGcCleanerWrapper>

org.apache.flink.util.JavaGcCleanerWrapper

All Implemented Interfaces:

Serializable, Comparable<JavaGcCleanerWrapper>

public enum JavaGcCleanerWrapper
extends Enum<JavaGcCleanerWrapper>

Java GC Cleaner wrapper.

A clean operation can be wrapped with the Java GC Cleaner which will schedule this operation before GC is run for the given owner object (not reachable in user code). but only if the cleaner has not been already run explicitly by user before. If the cleaner is run after GC it will not run clean operation again. This way we guarantee that the clean operation will always run at some point but only once.

The wrapper looks up the underlying Java GC Cleaner class in different packages

Method Summary

Modifier and Type	Method and Description
static Runnable	createCleaner(Object owner, Runnable cleanOperation)
static boolean	tryRunPendingCleaners()
static JavaGcCleanerWrapper	valueOf(String name) Returns the enum constant of this type with the specified name.
static JavaGcCleanerWrapper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static JavaGcCleanerWrapper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JavaGcCleanerWrapper c : JavaGcCleanerWrapper.values())
    System.out.println(c);

Returns:

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

valueOf

public static JavaGcCleanerWrapper valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

createCleaner

public static Runnable createCleaner(Object owner,
                                     Runnable cleanOperation)

tryRunPendingCleaners

public static boolean tryRunPendingCleaners()
                                     throws InterruptedException

Throws:

InterruptedException