Class AutoCloseables

java.lang.Object

org.apache.commons.lang3.AutoCloseables

public class AutoCloseables
extends Object

Static operations on AutoCloseable.

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

Since:

3.21.0

Method Summary

Modifier and Type	Method	Description
static void	close(AutoCloseable closeable)	Closes the given AutoCloseable as a null-safe operation.
static void	close(AutoCloseable closeable, FailableConsumer<Exception, Exception> consumer)	Closes the given AutoCloseable as a null-safe operation.
static void	closeQuietly(AutoCloseable closeable)	Closes an AutoCloseable, never throwing an Exception.
static void	closeQuietly(AutoCloseable closeable, Consumer<Exception> consumer)	Closes the given AutoCloseable as a null-safe operation while consuming Exception by the given consumer.
static void	closeQuietly(Iterable<AutoCloseable> closeables)	Closes an iterable of AutoCloseable, never throwing an Exception.
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.

Methods inherited from class Object

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

Method Details

close

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:

Exception - Thrown if an error occurs.

close

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:

Exception - Thrown if the consumer throws an exception.

closeQuietly

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)

closeQuietly

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().

closeQuietly

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)

closeQuietlySuppress

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)