net.openhft.chronicle.core.io

Interface Closeable

All Superinterfaces:

AutoCloseable, Closeable, QueryCloseable

All Known Subinterfaces:

EventLoop, IntArrayValues, IntValue, LongArrayValues, LongValue, ManagedCloseable, TwoLongValue

All Known Implementing Classes:

AbstractCloseable, AbstractCloseableReferenceCounted, DelegatingEventLoop, OnDemandEventLoop, SimpleCloseable, UnsafeCloseable

public interface Closeable
extends Closeable, QueryCloseable

A Closeable is a source or destination of data that can be closed. The close method is invoked to release resources that the object is holding (such as open files). This interface is an extension of Closeable and QueryCloseable, adding functionality for handling more resource types and closing them quietly without throwing exceptions.

It is encouraged to use this interface in a try-with-resources statement.

Implementations of this interface should also consider extending AbstractCloseable which provides common functionalities for closeable resources.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this resource, releasing any system resources associated with it.
static void	closeQuietly(Object... closeables) Closes multiple closeable objects quietly, without throwing exceptions.
static void	closeQuietly(@Nullable Object o) Closes a single closeable object quietly, without throwing exceptions.

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

isClosed, isClosing

Method Detail

closeQuietly

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

Closes multiple closeable objects quietly, without throwing exceptions. If a closeable object is a collection or an array, all the elements within it are closed. If a closeable object is a ServerSocketChannel, it is closed quietly.

Example:

 Closeable.closeQuietly(fileInputStream, socketChannel, listOfStreams);
 

Parameters:

closeables - the array of objects to be closed

See Also:

AbstractCloseable.performClose()

closeQuietly

static void closeQuietly(@Nullable
                         @Nullable Object o)

Closes a single closeable object quietly, without throwing exceptions. If the closeable object is a collection or an array, all the elements within it are closed. If the closeable object is a ServerSocketChannel, it is closed quietly.

Example:

 Closeable.closeQuietly(fileInputStream);
 

Parameters:

o - the object to be closed

See Also:

AbstractCloseable.performClose()

close

void close()

Closes this resource, releasing any system resources associated with it. If the resource is already closed, then invoking this method has no effect. This method should be idempotent.

Subclasses should override AbstractCloseable.performClose() to provide the actual close logic.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IllegalStateException - if the resource cannot be closed.

See Also:

AbstractCloseable.performClose()