net.openhft.chronicle.core.io

Interface ManagedCloseable

All Superinterfaces:

AutoCloseable, Closeable, QueryCloseable

All Known Implementing Classes:

AbstractCloseable, AbstractCloseableReferenceCounted, SimpleCloseable, UnsafeCloseable

public interface ManagedCloseable
extends Closeable

The ManagedCloseable interface extends the Closeable interface and provides additional methods that are primarily intended for expert use cases involving resource lifecycle management.

This interface is designed for scenarios where more fine-grained control over the closing process of a resource is needed, or where it is necessary to perform advanced operations based on the state of the resource.

Method Summary

Modifier and Type	Method and Description
default StackTrace	createdHere() Returns the stack trace of the location where the resource was created.
default void	throwExceptionIfClosed() Throws an exception if the resource is closed or in the process of closing.
default void	warnAndCloseIfNotClosed() Closes the resource if it is not already closed, and logs a warning if the resource was discarded without being closed.

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Method Detail

warnAndCloseIfNotClosed

default void warnAndCloseIfNotClosed()

Closes the resource if it is not already closed, and logs a warning if the resource was discarded without being closed. This method is intended for advanced use cases in resource lifecycle management.

When resource tracing is enabled and discard warnings are not disabled, a warning message is logged indicating that the resource was discarded without being properly closed. The resource is then closed quietly, meaning that no exception is thrown if an error occurs during the closing process.

throwExceptionIfClosed

default void throwExceptionIfClosed()
                             throws ClosedIllegalStateException,
                                    ThreadingIllegalStateException

Throws an exception if the resource is closed or in the process of closing. This method is intended for advanced use cases in resource lifecycle management.

If the resource is in the process of closing, a ClosedIllegalStateException is thrown. The exception message indicates whether the resource is already closed or is currently in the process of closing.

Throws:

ClosedIllegalStateException - If the resource has been released or closed.

ThreadingIllegalStateException - If the thread safety check fails.

createdHere

default StackTrace createdHere()

Returns the stack trace of the location where the resource was created. This method is intended for advanced use cases in resource lifecycle management.

By default, this method returns null, indicating that the information is not available. Implementations may override this method to provide the actual stack trace where the resource was created.

Returns:

The stack trace of the location where the resource was created, or null if the information is not available.