net.openhft.chronicle.core.internal

Class CloseableUtils

java.lang.Object

net.openhft.chronicle.core.internal.CloseableUtils

public final class CloseableUtils
extends Object

Utility class for managing closeable resources and related operations.

Method Summary

Modifier and Type	Method and Description
static void	add(Closeable closeable) Adds a closeable resource to the set of tracked resources.
static void	assertCloseablesClosed() Asserts that all closeable resources are closed.
static String	asString(Object id)
static void	closeQuietly(Object... closeables) Close a closeable quietly, i.e.
static void	disableCloseableTracing() Disables tracing of closeable resources.
static void	enableCloseableTracing() Enables tracing of closeable resources.
static void	gcAndWaitForCloseablesToClose() Performs garbage collection and waits for closeables to close.
static void	unmonitor(Closeable closeable)
static boolean	waitForCloseablesToClose(long millis) Waits for closeable resources to close within a specified time limit.

Methods inherited from class java.lang.Object

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

Method Detail

add

public static void add(Closeable closeable)

Adds a closeable resource to the set of tracked resources. If tracing is enabled, the closeable resource is added to the set for monitoring purposes.

Parameters:

closeable - The closeable resource to add.

enableCloseableTracing

public static void enableCloseableTracing()

Enables tracing of closeable resources. Tracked resources will be stored in a set. This method should be called to enable tracing before using closeable resources.

disableCloseableTracing

public static void disableCloseableTracing()

Disables tracing of closeable resources. Tracked resources will no longer be stored in the set. This method should be called to disable tracing when no longer needed.

gcAndWaitForCloseablesToClose

public static void gcAndWaitForCloseablesToClose()

Performs garbage collection and waits for closeables to close. This method is useful for ensuring that closeable resources are properly closed before continuing. It performs the following steps: 1. Performs cleanup on the current thread. 2. Performs garbage collection. 3. Waits for closeables to close with a specified timeout. 4. Checks if the finalizer thread has finalized any objects. If not, it throws an AssertionError.

Throws:

AssertionError - If the finalizer does not complete within the specified timeout.

waitForCloseablesToClose

public static boolean waitForCloseablesToClose(long millis)

Waits for closeable resources to close within a specified time limit. This method checks if the closeable resources in the trace set have been closed. If all resources are closed within the specified time limit, it returns true. If the time limit is exceeded before all resources are closed, it returns false.

Parameters:

millis - The time limit in milliseconds to wait for the closeable resources to close.

Returns:

true if all closeable resources are closed within the time limit, false otherwise.

assertCloseablesClosed

public static void assertCloseablesClosed()

Asserts that all closeable resources are closed. This method checks if there are any remaining open closeable resources. If any resources are found to be open, an AssertionError is thrown.

unmonitor

public static void unmonitor(Closeable closeable)

Parameters:

closeable - to remove monitoring of

closeQuietly

public static void closeQuietly(@Nullable
                                Object... closeables)

Close a closeable quietly, i.e. without throwing an exception. If the closeable is a collection, close all the elements. If the closeable is an array, close all the elements. If the closeable is a ServerSocketChannel, close it quietly.

Parameters:

closeables - the objects to close

asString

public static String asString(Object id)