org.whaka.util

Class UberCloser

java.lang.Object

org.whaka.util.UberCloser

public final class UberCloser
extends java.lang.Object

Util class provides usability static methods to close instances of AutoCloseable or Destroyable, or to perform any kind of dangerous close operations on any target.

There are two groups of methods, duplicating each other in arguments:

• close - if any exception was caught - it is rethrown as UberCloser.CloseException
• closeQuietly - if any exception was caught - it is logged using SLF4J logger with level 'WARN'

Note: even though methods taking DangerousConsumer as operation to be performed may be used to perform any kinds of operation - it is discouraged, since names of methods and logged messages or thrown exceptions are explicitly say about 'closing' something. Performing any other operation except actual closing or destroying may cause confusing code or error messages. Use Try to perform any other kind of operation.

See Also:

close(AutoCloseable, String), close(Destroyable, String), close(Object, DangerousConsumer, String), closeQuietly(AutoCloseable, String), closeQuietly(Destroyable, String), closeQuietly(Object, DangerousConsumer, String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UberCloser.CloseException Exception indicating an error happened during the closing process.

Method Summary

Modifier and Type	Method and Description
static void	close(java.lang.AutoCloseable closeable) Equal to close(AutoCloseable, String) with name produced from target object.
static void	close(java.lang.AutoCloseable closeable, java.lang.String name) Equal to close(Object, DangerousConsumer, String) where dangerous operation is AutoCloseable.close()
static void	close(Destroyable destroyable) Equal to close(Destroyable, String) with name produced from target object.
static void	close(Destroyable destroyable, java.lang.String name) Equal to close(Object, DangerousConsumer, String) where dangerous operation is Destroyable.destroy()
static <T> void	close(T target, DangerousConsumer<T,?> operation) Equal to close(Object, DangerousConsumer, String) with name produced from target object.
static <T> void	close(T target, DangerousConsumer<T,?> operation, java.lang.String name) If specified target is null - nothing happens.
static void	closeQuietly(java.lang.AutoCloseable closeable) Equal to closeQuietly(AutoCloseable, String) with name produced from target object.
static void	closeQuietly(java.lang.AutoCloseable closeable, java.lang.String name) Equal to closeQuietly(Object, DangerousConsumer, String) where dangerous operation is AutoCloseable.close()
static void	closeQuietly(Destroyable destroyable) Equal to closeQuietly(Destroyable, String) with name produced from target object.
static void	closeQuietly(Destroyable destroyable, java.lang.String name) Equal to closeQuietly(Object, DangerousConsumer, String) where dangerous operation is Destroyable.destroy()
static <T> void	closeQuietly(T target, DangerousConsumer<T,?> operation) Equal to closeQuietly(Object, DangerousConsumer, String) with name produced from target object.
static <T> void	closeQuietly(T target, DangerousConsumer<T,?> operation, java.lang.String name) If specified target is null - nothing happens.

Methods inherited from class java.lang.Object

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

Method Detail

close

public static void close(java.lang.AutoCloseable closeable)

Equal to close(AutoCloseable, String) with name produced from target object.

Throws:

UberCloser.CloseException

See Also:

close(AutoCloseable, String)

close

public static void close(java.lang.AutoCloseable closeable,
                         java.lang.String name)

Equal to close(Object, DangerousConsumer, String) where dangerous operation is AutoCloseable.close()

Throws:

UberCloser.CloseException

See Also:

close(AutoCloseable)

close

public static void close(Destroyable destroyable)

Equal to close(Destroyable, String) with name produced from target object.

Throws:

UberCloser.CloseException

See Also:

close(Destroyable, String)

close

public static void close(Destroyable destroyable,
                         java.lang.String name)

Equal to close(Object, DangerousConsumer, String) where dangerous operation is Destroyable.destroy()

Throws:

UberCloser.CloseException

See Also:

close(Destroyable)

close

public static <T> void close(T target,
                             DangerousConsumer<T,?> operation)

Equal to close(Object, DangerousConsumer, String) with name produced from target object.

Throws:

UberCloser.CloseException

See Also:

close(Object, DangerousConsumer, String)

close

public static <T> void close(T target,
                             DangerousConsumer<T,?> operation,
                             java.lang.String name)

If specified target is null - nothing happens. Otherwise specified dangerous operation is performed on the specified target. If any exception was raised - new instance of the UberCloser.CloseException is thrown with message containing specified name and with raised cause exception.

Throws:

UberCloser.CloseException

See Also:

close(Object, DangerousConsumer)

closeQuietly

public static void closeQuietly(java.lang.AutoCloseable closeable)

Equal to closeQuietly(AutoCloseable, String) with name produced from target object.

See Also:

closeQuietly(AutoCloseable, String)

closeQuietly

public static void closeQuietly(java.lang.AutoCloseable closeable,
                                java.lang.String name)

Equal to closeQuietly(Object, DangerousConsumer, String) where dangerous operation is AutoCloseable.close()

See Also:

closeQuietly(AutoCloseable)

closeQuietly

public static void closeQuietly(Destroyable destroyable)

Equal to closeQuietly(Destroyable, String) with name produced from target object.

See Also:

closeQuietly(Destroyable, String)

closeQuietly

public static void closeQuietly(Destroyable destroyable,
                                java.lang.String name)

Equal to closeQuietly(Object, DangerousConsumer, String) where dangerous operation is Destroyable.destroy()

See Also:

closeQuietly(Destroyable)

closeQuietly

public static <T> void closeQuietly(T target,
                                    DangerousConsumer<T,?> operation)

Equal to closeQuietly(Object, DangerousConsumer, String) with name produced from target object.

See Also:

closeQuietly(Object, DangerousConsumer, String)

closeQuietly

public static <T> void closeQuietly(T target,
                                    DangerousConsumer<T,?> operation,
                                    java.lang.String name)

If specified target is null - nothing happens. Otherwise specified dangerous operation is performed on the specified target. If any exception was raised - it is logged thru SLF4J logger with 'WARN' level.

See Also:

closeQuietly(Object, DangerousConsumer)