Package de.aristaflow.adept2.util.io

Class IoTools

java.lang.Object

de.aristaflow.adept2.util.io.IoTools

public class IoTools
extends Object

A class providing several IO-related tool methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IoTools.Quiet<C extends AutoCloseable>	This class wraps an AutoCloseable and logs the exception from closing.
static class	IoTools.Unchecked<C extends AutoCloseable>	This class wraps an AutoCloseable and wraps the exception from closing in a RuntimeException if necessary.

Constructor Summary

Constructors

Constructor	Description
IoTools()

Method Summary

Modifier and Type	Method	Description
static <C extends Closeable> C	close(C closeable)	Closes the designated Closeable and returns null.
static void	close(AutoCloseable... closeables)	Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.
static void	close(Collection<? extends Object> objects)	Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.
static void	closeAuto(AutoCloseable... closeables)	Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.
static void	closeAuto(Collection<? extends Object> objects)	Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.
static void	closeLogged(Logger logger, AutoCloseable... closeables)	Closes the AutoCloseables in the designated objects logging all exceptions as Level.INFO to the designated logger.
static void	closeLogged(Logger logger, Collection<? extends Object> objects)	Closes the AutoCloseables in the designated objects logging all exceptions as Level.INFO to the designated logger.
static void	closeUnchecked(AutoCloseable... closeables)	Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.
static void	closeUnchecked(Collection<? extends Object> objects)	Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.
static <C extends AutoCloseable> IoTools.Quiet<C>	quiet(Logger logger, C closeable)	Wraps the designated AutoCloseable in an unconditional AutoCloseable that logs any exception thrown by AutoCloseable.close().
static <C extends AutoCloseable> IoTools.Quiet<C>	quiet(Logger logger, Supplier<Boolean> condition, C closeable)	Wraps the designated AutoCloseable in a conditional AutoCloseable that logs any exception thrown by AutoCloseable.close().
static <C extends AutoCloseable> IoTools.Unchecked<C>	unchecked(C closeable)	Wraps the designated AutoCloseable in an unconditional AutoCloseable that in turn wraps any checked exceptions thrown by AutoCloseable.close() in a RuntimeException.
static <C extends AutoCloseable> IoTools.Unchecked<C>	unchecked(Supplier<Boolean> condition, C closeable)	Wraps the designated AutoCloseable in a conditional AutoCloseable that in turn wraps any checked exceptions thrown by AutoCloseable.close() in a RuntimeException.

Methods inherited from class java.lang.Object

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

Constructor Detail

IoTools

public IoTools()

Method Detail

close

public static <C extends Closeable> C close(C closeable)
                                     throws IOException

Closes the designated Closeable and returns null. This way, a Closeable can be closed and removed in one step preventing the field to be closed again.

Usually you only need this for implementing Closeable.close() or Cleanup.

Type Parameters:

C - The type of closeable.

Parameters:

closeable - the Closeable to be closed

Returns:

Always null.

Throws:

IOException - if Closeable.close() throws an exception

close

public static void close(AutoCloseable... closeables)
                  throws IOException

Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed. If the first exception is a checked exception other than IOException, it will be wrapped in one.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

closeables - The AutoCloseables to be closed.

Throws:

IOException - The first occurred IOException having all following exceptions chained.

RuntimeException - The first occurred RuntimeException having all following exceptions chained.

See Also:

close(Collection)

close

public static void close(Collection<? extends Object> objects)
                  throws IOException

Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed. If the first exception is a checked exception other than IOException, it will be wrapped in one.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

objects - The AutoCloseables to be closed. Other kinds of objects will just be ignored. This may be null.

Throws:

IOException - The first occurred IOException having all following exceptions chained.

RuntimeException - The first occurred RuntimeException having all following exceptions chained.

closeUnchecked

public static void closeUnchecked(AutoCloseable... closeables)

Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed. If the first exception is a checked exception, it will be wrapped in an RuntimeException.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

closeables - The AutoCloseables to be closed while accumulating occurring Exceptions and rethrowing them in a RuntimeException.

See Also:

closeUnchecked(Collection)

closeUnchecked

public static void closeUnchecked(Collection<? extends Object> objects)

Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed. If the first exception is a checked exception, it will be wrapped in an RuntimeException.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

objects - The objects possibly being AutoCloseable to be closed while accumulating occurring Exceptions and rethrowing them in a RuntimeException.

See Also:

close(Collection)

closeLogged

public static void closeLogged(Logger logger,
                               AutoCloseable... closeables)

Closes the AutoCloseables in the designated objects logging all exceptions as Level.INFO to the designated logger. The objects will be identified in the log message via their Object.toString().

In case of Errors it will still be attempted to close all AutoCloseables anyway. But otherwise the first error will be rethrown at the end and subsequent errors will be suppressed.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

logger - The logger to which to log all occurred IOExceptions and RuntimeExceptions.

closeables - The AutoCloseables to be closed while logging occurring exceptions.

See Also:

closeLogged(Logger, Collection)

closeLogged

public static void closeLogged(Logger logger,
                               Collection<? extends Object> objects)

Closes the AutoCloseables in the designated objects logging all exceptions as Level.INFO to the designated logger. The objects will be identified in the log message via their Object.toString().

In case of Errors it will still be attempted to close all AutoCloseables anyway. But otherwise the first error will be rethrown at the end and subsequent errors will be suppressed.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

logger - The logger to which to log all occurred IOExceptions and RuntimeExceptions.

objects - The objects possibly being AutoCloseable to be closed while logging occurring exceptions.

closeAuto

public static void closeAuto(AutoCloseable... closeables)
                      throws Exception

Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

closeables - The AutoCloseables to be closed while accumulating occurring Exceptions and Errors.

Throws:

Exception - The first occurred exception having all following chained.

See Also:

closeAuto(Collection)

closeAuto

public static void closeAuto(Collection<? extends Object> objects)
                      throws Exception

Closes the AutoCloseables in the designated objects, delaying any encountered Exceptions or Errors until the end, where the first exception or error will be thrown with all subsequent exceptions or errors being suppressed.

Usually you only need this for implementing AutoCloseable.close() or Cleanup.

Parameters:

objects - The objects possibly being AutoCloseable to be closed while accumulating occurring Exceptions. This may be null.

Throws:

Exception - The first occurred exception having all following chained.

quiet

public static <C extends AutoCloseable> IoTools.Quiet<C> quiet(Logger logger,
                                                               C closeable)

Wraps the designated AutoCloseable in an unconditional AutoCloseable that logs any exception thrown by AutoCloseable.close(). This allows for usage in a try-with-resources.

Type Parameters:

C - The type of the closeable which to close quietly.

Parameters:

logger - The logger to which to log an occurred exception.

closeable - The closeable which to close quietly.

Returns:

A wrapper for closing the designated closeable quietly.

See Also:

closeLogged(Logger, AutoCloseable...)

quiet

public static <C extends AutoCloseable> IoTools.Quiet<C> quiet(Logger logger,
                                                               Supplier<Boolean> condition,
                                                               C closeable)

Wraps the designated AutoCloseable in a conditional AutoCloseable that logs any exception thrown by AutoCloseable.close(). This allows for usage in a try-with-resources.

Type Parameters:

C - The type of the closeable which to close quietly.

Parameters:

logger - The logger to which to log an occurred exception.

condition - The optional condition allowing for conditional closing or null for unconditional closing.

closeable - The closeable which to close quietly.

Returns:

A wrapper for closing the designated closeable quietly.

See Also:

closeLogged(Logger, AutoCloseable...)

unchecked

public static <C extends AutoCloseable> IoTools.Unchecked<C> unchecked(C closeable)

Wraps the designated AutoCloseable in an unconditional AutoCloseable that in turn wraps any checked exceptions thrown by AutoCloseable.close() in a RuntimeException. This allows for usage in a try-with-resources.

Type Parameters:

C - The type of the closeable which to close quietly.

Parameters:

closeable - The closeable which to close quietly.

Returns:

A wrapper for closing the designated closeable quietly.

See Also:

closeUnchecked(AutoCloseable...)

unchecked

public static <C extends AutoCloseable> IoTools.Unchecked<C> unchecked(Supplier<Boolean> condition,
                                                                       C closeable)

Wraps the designated AutoCloseable in a conditional AutoCloseable that in turn wraps any checked exceptions thrown by AutoCloseable.close() in a RuntimeException. This allows for usage in a try-with-resources.

Type Parameters:

C - The type of the closeable which to close quietly.

Parameters:

condition - The optional condition allowing for conditional closing or null for unconditional closing.

closeable - The closeable which to close quietly.

Returns:

A wrapper for closing the designated closeable quietly.

See Also:

closeUnchecked(AutoCloseable...)