Package org.hibernate.search.util.common.impl

Class SuppressingCloser

java.lang.Object

org.hibernate.search.util.common.impl.AbstractCloser<SuppressingCloser,Exception>

org.hibernate.search.util.common.impl.SuppressingCloser

public final class SuppressingCloser
extends AbstractCloser<SuppressingCloser,Exception>

A helper for closing multiple resources and re-throwing a provided exception, suppressing any exceptions caught while closing.

This class is not thread safe.

This helper is mainly useful when implementing a catch block where resources must be closed, to make sure that all resources are at least given the chance to close, even if closing one of them fails, and that you can still re-throw the originally caught exception.

See the AbstractCloser superclass for a list of methods allowing to close objects while catching exceptions.

Constructor Summary

Constructors

Constructor	Description
SuppressingCloser(Throwable mainThrowable)

Method Summary

Modifier and Type	Method	Description
SuppressingCloser	push(AutoCloseable closeable)	Close the given closeable immediately, swallowing any throwable in order to add it as suppressed to the main throwable.
<T> SuppressingCloser	push(T objectToExtractFrom, Function<T,? extends AutoCloseable> extract)	Close the closeable extracted from objectToExtractFrom immediately, swallowing any throwable in order to add it as suppressed to the main throwable.
SuppressingCloser	pushAll(AutoCloseable... closeables)	Close the given closeables immediately, swallowing any throwable in order to add it as suppressed to the main throwable.
SuppressingCloser	pushAll(Iterable<? extends AutoCloseable> closeables)	Close the given closeables immediately, swallowing any throwable in order to add it as suppressed to the main throwable.
<U> SuppressingCloser	pushAll(Iterable<? extends U> objectsToExtractFrom, Function<U,AutoCloseable> extract)	Close the AutoCloseable elements extracted from elements of objectToExtractFrom immediately, swallowing any throwable in order to add it as suppressed to the main throwable.

Methods inherited from class org.hibernate.search.util.common.impl.AbstractCloser

push, push, pushAll, pushAll, pushAll

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressingCloser

public SuppressingCloser(Throwable mainThrowable)

Method Detail

push

public SuppressingCloser push(AutoCloseable closeable)

Close the given closeable immediately, swallowing any throwable in order to add it as suppressed to the main throwable.

See also AbstractCloser.push(ClosingOperator, Object) for when the object to close does not implement AutoCloseable.

Parameters:

closeable - An AutoCloseable to close.

Returns:

this, for method chaining.

push

public <T> SuppressingCloser push(T objectToExtractFrom,
                                  Function<T,? extends AutoCloseable> extract)

Close the closeable extracted from objectToExtractFrom immediately, swallowing any throwable in order to add it as suppressed to the main throwable.

See also AbstractCloser.push(ClosingOperator, Object) for when the object to close does not implement AutoCloseable.

Parameters:

objectToExtractFrom - An object from which to extract the object to close.

extract - A function to extract an object to close from objectToExtractFrom. Accepts lambdas such as MyType::get.

Returns:

this, for method chaining.

pushAll

public SuppressingCloser pushAll(AutoCloseable... closeables)

Close the given closeables immediately, swallowing any throwable in order to add it as suppressed to the main throwable.

See also AbstractCloser.pushAll(ClosingOperator, Object[]) for when the objects to close do not implement AutoCloseable.

Parameters:

closeables - An array of AutoCloseables to close.

Returns:

this, for method chaining.

pushAll

public SuppressingCloser pushAll(Iterable<? extends AutoCloseable> closeables)

Close the given closeables immediately, swallowing any throwable in order to add it as suppressed to the main throwable.

See also AbstractCloser.pushAll(ClosingOperator, Iterable) for when the objects to close do not implement AutoCloseable.

Parameters:

closeables - An iterable of AutoCloseables to close.

Returns:

this, for method chaining.

pushAll

public <U> SuppressingCloser pushAll(Iterable<? extends U> objectsToExtractFrom,
                                     Function<U,AutoCloseable> extract)

Close the AutoCloseable elements extracted from elements of objectToExtractFrom immediately, swallowing any throwable in order to add it as suppressed to the main throwable.

See also AbstractCloser.pushAll(ClosingOperator, Iterable, Function) for when the objects to close do not implement AutoCloseable.

Parameters:

objectsToExtractFrom - An iterable of objects from which to extract the objects to close.

extract - A function to extract an object to close from the elements of objectsToExtractFrom. Accepts lambdas such as MyType::get.

Returns:

this, for method chaining.