Module org.apache.arrow.memory.core

Package org.apache.arrow.util

Class AutoCloseables

java.lang.Object

org.apache.arrow.util.AutoCloseables

public final class AutoCloseables
extends Object

Utilities for AutoCloseable classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AutoCloseables.RollbackCloseable	A closeable wrapper that will close the underlying closeables if a commit does not occur.

Method Summary

Modifier and Type	Method	Description
static AutoCloseable	all(@Nullable Collection<? extends @Nullable AutoCloseable> autoCloseables)	Returns a new AutoCloseable that calls close(Iterable) on autoCloseables when close is called.
static void	close(@Nullable AutoCloseable... autoCloseables)	Closes all autoCloseables if not null and suppresses subsequent exceptions if more than one.
static void	close(@Nullable Iterable<? extends @Nullable AutoCloseable> ac)	Closes all autoCloseables if not null and suppresses subsequent exceptions if more than one.
static void	close(@Nullable Iterable<? extends @Nullable AutoCloseable>... closeables)	Calls close(Iterable) on the flattened list of closeables.
static void	close(Throwable t, @Nullable AutoCloseable... autoCloseables)	Closes all autoCloseables if not null and suppresses exceptions by adding them to t.
static void	close(Throwable t, @Nullable Iterable<? extends @Nullable AutoCloseable> autoCloseables)	Closes all autoCloseables if not null and suppresses exceptions by adding them to t.
static void	closeNoChecked(@Nullable AutoCloseable autoCloseable)	close() an AutoCloseable without throwing a (checked) Exception.
static Iterable<AutoCloseable>	iter(@Nullable AutoCloseable... ac)	Converts ac to a Iterable filtering out any null values.
static AutoCloseable	noop()	Get an AutoCloseable that does nothing.
static AutoCloseables.RollbackCloseable	rollbackable(@Nullable AutoCloseable... closeables)	Creates an AutoCloseables.RollbackCloseable from the given closeables.

Methods inherited from class java.lang.Object

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

Method Details

all

public static AutoCloseable all(@Nullable Collection<? extends @Nullable AutoCloseable> autoCloseables)

Returns a new AutoCloseable that calls close(Iterable) on autoCloseables when close is called.

close

public static void close(Throwable t,
 @Nullable AutoCloseable... autoCloseables)

Closes all autoCloseables if not null and suppresses exceptions by adding them to t.

Parameters:

t - the throwable to add suppressed exception to

autoCloseables - the closeables to close

close

public static void close(Throwable t,
 @Nullable Iterable<? extends @Nullable AutoCloseable> autoCloseables)

Closes all autoCloseables if not null and suppresses exceptions by adding them to t.

Parameters:

t - the throwable to add suppressed exception to

autoCloseables - the closeables to close

close

public static void close(@Nullable AutoCloseable... autoCloseables)
                  throws Exception

Closes all autoCloseables if not null and suppresses subsequent exceptions if more than one.

Parameters:

autoCloseables - the closeables to close

Throws:

Exception

close

public static void close(@Nullable Iterable<? extends @Nullable AutoCloseable> ac)
                  throws Exception

Closes all autoCloseables if not null and suppresses subsequent exceptions if more than one.

Parameters:

ac - the closeables to close

Throws:

Exception

close

@SafeVarargs
public static void close(@Nullable Iterable<? extends @Nullable AutoCloseable>... closeables)
                  throws Exception

Calls close(Iterable) on the flattened list of closeables.

Throws:

Exception

iter

public static Iterable<AutoCloseable> iter(@Nullable AutoCloseable... ac)

Converts ac to a Iterable filtering out any null values.

rollbackable

public static AutoCloseables.RollbackCloseable rollbackable(@Nullable AutoCloseable... closeables)

Creates an AutoCloseables.RollbackCloseable from the given closeables.

closeNoChecked

public static void closeNoChecked(@Nullable AutoCloseable autoCloseable)

close() an AutoCloseable without throwing a (checked) Exception. This wraps the close() call with a try-catch that will rethrow an Exception wrapped with a RuntimeException, providing a way to call close() without having to do the try-catch everywhere or propagate the Exception.

Parameters:

autoCloseable - the AutoCloseable to close; may be null

Throws:

RuntimeException - if an Exception occurs; the Exception is wrapped by the RuntimeException

noop

public static AutoCloseable noop()

Get an AutoCloseable that does nothing.

Returns:

A do-nothing autocloseable