iaik.pkcs.pkcs11

Class Cleaner

java.lang.Object

iaik.pkcs.pkcs11.Cleaner

public class Cleaner
extends java.lang.Object

This class is a wrapper for the java.lang.ref.Cleaner class. It is used to create a Cleaner object in a way that is compatible with Java 8 and below.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cleaner.Cleanable Returned by the register method to allow the caller to clean up the object manually and be sure that the method is not called again.

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	getInstance() Returns a lazily initialized, global, static Cleaner object if the current Java version supports it.
static Cleaner.Cleanable	register(java.lang.Object object) Registers an object for cleanup.
static Cleaner.Cleanable	register(java.lang.Object object, java.lang.Runnable runnable) Registers an object for cleanup.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static java.lang.Object getInstance()

Returns a lazily initialized, global, static Cleaner object if the current Java version supports it.

Returns:

a Cleaner object if the current Java version supports it, null otherwise

register

public static Cleaner.Cleanable register(java.lang.Object object,
                                         java.lang.Runnable runnable)

Registers an object for cleanup. The object must implement a cleanup method that takes no arguments provided by the runnable parameter. This cleanup method will be called by the cleaner thread when the object is no longer reachable.

Parameters:

object - the object to register for cleanup

runnable - the runnable that provides the cleanup method

Returns:

a Cleanable object that allows the caller to clean up the object manually

register

public static Cleaner.Cleanable register(java.lang.Object object)

Registers an object for cleanup. The object must implement a method called clean that takes no arguments. This cleanup method will be called by the cleaner thread when the object is no longer reachable.

Parameters:

object - the object to register for cleanup

Returns:

a Cleanable object that allows the caller to clean up the object manually