AutoCloseables

public class org.apache.commons.lang3.AutoCloseables

Static operations on AutoCloseable.

For Closeable-specific methods, see Apache Commons IO’s IOUtils.

Since:

3.21.0

Methods

close(AutoCloseable)	Closes the given AutoCloseable as a null-safe operation.
close(AutoCloseable, FailableConsumer)	Closes the given AutoCloseable as a null-safe operation.
closeQuietly(AutoCloseable)	Closes an AutoCloseable, never throwing an Exception.
closeQuietly(AutoCloseable, Consumer)	Closes the given AutoCloseable as a null-safe operation while consuming Exception by the given consumer.
closeQuietly(Iterable)	Closes an iterable of AutoCloseable, never throwing an Exception.
closeQuietlySuppress(Closeable, Throwable)	Closes a Closeable unconditionally and adds any exception thrown by the close() to the given Throwable.

public static void close(AutoCloseable closeable) throws Exception

Closes the given AutoCloseable as a null-safe operation.

Parameters:

closeable – The resource to close, may be null.

Throws:

java.lang.Exception – Thrown if an error occurs.

public static void close(AutoCloseable closeable, FailableConsumer<Exception, Exception> consumer) throws Exception

Closes the given AutoCloseable as a null-safe operation.

Parameters:

• closeable – The resource to close, may be null.

• consumer – Consume the Exception thrown by AutoCloseable#close().

Throws:

java.lang.Exception – Thrown if the consumer throws an exception.

public static void closeQuietly(AutoCloseable closeable)

Closes an AutoCloseable, never throwing an Exception.

Equivalent to AutoCloseable#close(), except any exceptions will be ignored.

Parameters:

closeable – The objects to close, may be null or already closed.

See also:

Throwable#addSuppressed(Throwable)

public static void closeQuietly(AutoCloseable closeable, Consumer<Exception> consumer)

Closes the given AutoCloseable as a null-safe operation while consuming Exception by the given consumer.

Parameters:

• closeable – The resource to close, may be null.

• consumer – Consumes the Exception thrown by AutoCloseable#close().

public static void closeQuietly(Iterable<AutoCloseable> closeables)

Closes an iterable of AutoCloseable, never throwing an Exception.

Equivalent calling AutoCloseable#close() on each element, except any exceptions will be ignored.

Parameters:

closeables – The objects to close, may be null or already closed.

See also:

#closeQuietly(AutoCloseable)

public static <T extends Throwable> T closeQuietlySuppress(Closeable closeable, T throwable)

Closes a Closeable unconditionally and adds any exception thrown by the close() to the given Throwable.

For example:

AutoCloseable autoCloseable = ...;
try {
    // process autoCloseable.
} catch (Exception e) {
    // Handle exception.
    throw AutoCloseables.closeQuietlySuppress(autoCloseable, e);
}

Also consider using a try-with-resources statement where appropriate.

Type parameters:

<T> – The Throwable type.

Parameters:

• closeable – The object to close, may be null or already closed.

• throwable – Add the exception throw by the closeable to the given Throwable.

Returns:

The given Throwable.

See also:

Throwable#addSuppressed(Throwable)