Module com.aoapps.lang

Package com.aoapps.lang

Class AutoCloseables

java.lang.Object

com.aoapps.lang.AutoCloseables

public final class AutoCloseables
extends Object

Utilities for working with AutoCloseable.

Method Summary

Modifier and Type	Method	Description
static Throwable	closeAndCatch(AutoCloseable closeable)	Closes the given AutoCloseable, catching all Throwable.
static Throwable	closeAndCatch(AutoCloseable... closeable)	Closes all of the given AutoCloseable in order, catching all Throwable.
static Throwable	closeAndCatch(Iterable<? extends AutoCloseable> closeable)	Closes all of the given AutoCloseable in order, catching all Throwable.
static Throwable	closeAndCatch(Throwable t0, AutoCloseable closeable)	Closes the given AutoCloseable, catching all Throwable.
static Throwable	closeAndCatch(Throwable t0, AutoCloseable... closeable)	Closes all of the given AutoCloseable in order, catching all Throwable.
static Throwable	closeAndCatch(Throwable t0, Iterable<? extends AutoCloseable> closeable)	Closes all of the given AutoCloseable in order, catching all Throwable.
static <X extends Throwable> void	closeAndThrow(Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, AutoCloseable closeable)	Closes the given AutoCloseable in order, throwing all Throwable, wrapping when needed.
static <X extends Throwable> void	closeAndThrow(Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, AutoCloseable... closeable)	Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.
static <X extends Throwable> void	closeAndThrow(Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, Iterable<? extends AutoCloseable> closeable)	Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.
static <X extends Throwable> void	closeAndThrow(Throwable t0, Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, AutoCloseable closeable)	Closes the given AutoCloseable in order, throwing all Throwable, wrapping when needed.
static <X extends Throwable> void	closeAndThrow(Throwable t0, Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, AutoCloseable... closeable)	Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.
static <X extends Throwable> void	closeAndThrow(Throwable t0, Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, Iterable<? extends AutoCloseable> closeable)	Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.
static <X extends Throwable> X	closeAndWrap(Throwable t0, Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, AutoCloseable closeable)	Closes the given AutoCloseable, catching all Throwable.
static <X extends Throwable> X	closeAndWrap(Throwable t0, Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, AutoCloseable... closeable)	Closes all of the given AutoCloseable in order, catching all Throwable.
static <X extends Throwable> X	closeAndWrap(Throwable t0, Class<? extends X> xClass, Function<? super Throwable,? extends X> xSupplier, Iterable<? extends AutoCloseable> closeable)	Closes all of the given AutoCloseable in order, catching all Throwable.

Methods inherited from class java.lang.Object

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

Method Detail

closeAndCatch

public static Throwable closeAndCatch(Throwable t0,
                                      AutoCloseable closeable)

Closes the given AutoCloseable, catching all Throwable.

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

closeable - The closeable to be closed

Returns:

t0, a new throwable, or null when none given and none new

closeAndCatch

public static Throwable closeAndCatch(AutoCloseable closeable)

Closes the given AutoCloseable, catching all Throwable.

Parameters:

closeable - The closeable to be closed

Returns:

A new throwable or null

closeAndCatch

public static Throwable closeAndCatch(Throwable t0,
                                      AutoCloseable... closeable)

Closes all of the given AutoCloseable in order, catching all Throwable.

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

closeable - The set of all closeables, which will be closed in order

Returns:

t0, a new throwable, or null when none given and none new

closeAndCatch

public static Throwable closeAndCatch(AutoCloseable... closeable)

Closes all of the given AutoCloseable in order, catching all Throwable.

Parameters:

closeable - The set of all closeables, which will be closed in order

Returns:

A new throwable or null

closeAndCatch

public static Throwable closeAndCatch(Throwable t0,
                                      Iterable<? extends AutoCloseable> closeable)

Closes all of the given AutoCloseable in order, catching all Throwable.

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

closeable - The set of all closeables, which will be closed in order

Returns:

t0, a new throwable, or null when none given and none new

closeAndCatch

public static Throwable closeAndCatch(Iterable<? extends AutoCloseable> closeable)

Closes all of the given AutoCloseable in order, catching all Throwable.

Parameters:

closeable - The set of all closeables, which will be closed in order

Returns:

A new throwable or null

closeAndThrow

public static <X extends Throwable> void closeAndThrow(Throwable t0,
                                                       Class<? extends X> xClass,
                                                       Function<? super Throwable,? extends X> xSupplier,
                                                       AutoCloseable closeable)
                                                throws Error,
                                                       RuntimeException,
                                                       X extends Throwable

Closes the given AutoCloseable in order, throwing all Throwable, wrapping when needed.

Only returns when t0 is null and no new throwables.

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

xClass - Throwables of this class, as well as Error and RuntimeException, are thrown directly.

xSupplier - Other throwables are wrapped via this function, then thrown

closeable - The closeable to be closed

Throws:

Error - When resolved throwable is an Error

RuntimeException - When resolved throwable is a RuntimeException

X - When resolved throwable is an instance of xClass, otherwise wrapped via xSupplier

X extends Throwable

closeAndThrow

public static <X extends Throwable> void closeAndThrow(Class<? extends X> xClass,
                                                       Function<? super Throwable,? extends X> xSupplier,
                                                       AutoCloseable closeable)
                                                throws Error,
                                                       RuntimeException,
                                                       X extends Throwable

Closes the given AutoCloseable in order, throwing all Throwable, wrapping when needed.

Only returns when no throwables.

Parameters:

xClass - Throwables of this class, as well as Error and RuntimeException, are thrown directly.

xSupplier - Other throwables are wrapped via this function, then thrown

closeable - The closeable to be closed

Throws:

Error - When resolved throwable is an Error

RuntimeException - When resolved throwable is a RuntimeException

X - When resolved throwable is an instance of xClass, otherwise wrapped via xSupplier

X extends Throwable

closeAndThrow

public static <X extends Throwable> void closeAndThrow(Throwable t0,
                                                       Class<? extends X> xClass,
                                                       Function<? super Throwable,? extends X> xSupplier,
                                                       AutoCloseable... closeable)
                                                throws Error,
                                                       RuntimeException,
                                                       X extends Throwable

Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.

Only returns when t0 is null and no new throwables.

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

xClass - Throwables of this class, as well as Error and RuntimeException, are thrown directly.

xSupplier - Other throwables are wrapped via this function, then thrown

closeable - The set of all closeables, which will be closed in order

Throws:

Error - When resolved throwable is an Error

RuntimeException - When resolved throwable is a RuntimeException

X - When resolved throwable is an instance of xClass, otherwise wrapped via xSupplier

X extends Throwable

closeAndThrow

public static <X extends Throwable> void closeAndThrow(Class<? extends X> xClass,
                                                       Function<? super Throwable,? extends X> xSupplier,
                                                       AutoCloseable... closeable)
                                                throws Error,
                                                       RuntimeException,
                                                       X extends Throwable

Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.

Only returns when no throwables.

Parameters:

xClass - Throwables of this class, as well as Error and RuntimeException, are thrown directly.

xSupplier - Other throwables are wrapped via this function, then thrown

closeable - The set of all closeables, which will be closed in order

Throws:

Error - When resolved throwable is an Error

RuntimeException - When resolved throwable is a RuntimeException

X - When resolved throwable is an instance of xClass, otherwise wrapped via xSupplier

X extends Throwable

closeAndThrow

public static <X extends Throwable> void closeAndThrow(Throwable t0,
                                                       Class<? extends X> xClass,
                                                       Function<? super Throwable,? extends X> xSupplier,
                                                       Iterable<? extends AutoCloseable> closeable)
                                                throws Error,
                                                       RuntimeException,
                                                       X extends Throwable

Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.

Only returns when t0 is null and no new throwables.

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

xClass - Throwables of this class, as well as Error and RuntimeException, are thrown directly.

xSupplier - Other throwables are wrapped via this function, then thrown

closeable - The set of all closeables, which will be closed in order

Throws:

Error - When resolved throwable is an Error

RuntimeException - When resolved throwable is a RuntimeException

X - When resolved throwable is an instance of xClass, otherwise wrapped via xSupplier

X extends Throwable

closeAndThrow

public static <X extends Throwable> void closeAndThrow(Class<? extends X> xClass,
                                                       Function<? super Throwable,? extends X> xSupplier,
                                                       Iterable<? extends AutoCloseable> closeable)
                                                throws Error,
                                                       RuntimeException,
                                                       X extends Throwable

Closes all of the given AutoCloseable in order, throwing all Throwable, wrapping when needed.

Only returns when no throwables.

Parameters:

xClass - Throwables of this class, as well as Error and RuntimeException, are thrown directly.

xSupplier - Other throwables are wrapped via this function, then thrown

closeable - The set of all closeables, which will be closed in order

Throws:

Error - When resolved throwable is an Error

RuntimeException - When resolved throwable is a RuntimeException

X - When resolved throwable is an instance of xClass, otherwise wrapped via xSupplier

X extends Throwable

closeAndWrap

public static <X extends Throwable> X closeAndWrap(Throwable t0,
                                                   Class<? extends X> xClass,
                                                   Function<? super Throwable,? extends X> xSupplier,
                                                   AutoCloseable closeable)

Closes the given AutoCloseable, catching all Throwable. Wraps any resulting throwable, unless is an instance of xClass, Error, or RuntimeException.

1. When null, returns null.
2. When is an instance of xClass, returns the exception.
3. When is Error or RuntimeException, throws the exception directly.
4. Otherwise, returns the exception wrapped via xSupplier.

This is expected to typically used within a catch block, to throw a narrower scope:

try {
   …
 } catch(Throwable t) {
   throw AutoCloseables.closeAndWrap(t, SQLException.class, SQLException::new, closeable);
 }

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

xClass - Throwables of this class are returned directly.

xSupplier - Throwables that a not returned directly, and are not Error or RuntimeException, are wrapped via this function, then returned.

closeable - The closeable to be closed

Returns:

null when t0 is null and no new throwables, resulting throwable when is an instance of xClass, otherwise wrapped via xSupplier.

Throws:

Error - When resulting throwable is an Error

RuntimeException - When resulting throwable is a RuntimeException

See Also:

Throwables.wrap(java.lang.Throwable, java.lang.Class, java.util.function.Function)

closeAndWrap

public static <X extends Throwable> X closeAndWrap(Throwable t0,
                                                   Class<? extends X> xClass,
                                                   Function<? super Throwable,? extends X> xSupplier,
                                                   AutoCloseable... closeable)

Closes all of the given AutoCloseable in order, catching all Throwable. Wraps any resulting throwable, unless is an instance of xClass, Error, or RuntimeException.

1. When null, returns null.
2. When is an instance of xClass, returns the exception.
3. When is Error or RuntimeException, throws the exception directly.
4. Otherwise, returns the exception wrapped via xSupplier.

This is expected to typically used within a catch block, to throw a narrower scope:

try {
   …
 } catch(Throwable t) {
   throw AutoCloseables.closeAndWrap(t, SQLException.class, SQLException::new, closeable);
 }

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

xClass - Throwables of this class are returned directly.

xSupplier - Throwables that a not returned directly, and are not Error or RuntimeException, are wrapped via this function, then returned.

closeable - The set of all closeables, which will be closed in order

Returns:

null when t0 is null and no new throwables, resulting throwable when is an instance of xClass, otherwise wrapped via xSupplier.

Throws:

Error - When resulting throwable is an Error

RuntimeException - When resulting throwable is a RuntimeException

See Also:

Throwables.wrap(java.lang.Throwable, java.lang.Class, java.util.function.Function)

closeAndWrap

public static <X extends Throwable> X closeAndWrap(Throwable t0,
                                                   Class<? extends X> xClass,
                                                   Function<? super Throwable,? extends X> xSupplier,
                                                   Iterable<? extends AutoCloseable> closeable)

Closes all of the given AutoCloseable in order, catching all Throwable. Wraps any resulting throwable, unless is an instance of xClass, Error, or RuntimeException.

1. When null, returns null.
2. When is an instance of xClass, returns the exception.
3. When is Error or RuntimeException, throws the exception directly.
4. Otherwise, returns the exception wrapped via xSupplier.

This is expected to typically used within a catch block, to throw a narrower scope:

try {
   …
 } catch(Throwable t) {
   throw AutoCloseables.closeAndWrap(t, SQLException.class, SQLException::new, closeable);
 }

Parameters:

t0 - If not null, any new throwables will be combined via Throwables.addSuppressed(java.lang.Throwable, java.lang.Throwable)

xClass - Throwables of this class are returned directly.

xSupplier - Throwables that a not returned directly, and are not Error or RuntimeException, are wrapped via this function, then returned.

closeable - The set of all closeables, which will be closed in order

Returns:

null when t0 is null and no new throwables, resulting throwable when is an instance of xClass, otherwise wrapped via xSupplier.

Throws:

Error - When resulting throwable is an Error

RuntimeException - When resulting throwable is a RuntimeException

See Also:

Throwables.wrap(java.lang.Throwable, java.lang.Class, java.util.function.Function)