Package me.lucko.scriptcontroller.closable

Interface CompositeAutoClosable

All Superinterfaces:

AutoCloseable

public interface CompositeAutoClosable
extends AutoCloseable

Represents an AutoCloseable made up of several other AutoCloseables.

The close() method closes in LIFO (Last-In-First-Out) order.

CompositeAutoClosables can be reused. The instance is effectively cleared on each invocation of close().

Method Summary

Modifier and Type	Method	Description
CompositeAutoClosable	bind(AutoCloseable autoCloseable)	Binds an AutoCloseable with this composite closable.
default CompositeAutoClosable	bindAll(AutoCloseable... autoCloseables)	Binds all given AutoCloseable with this composite closable.
default CompositeAutoClosable	bindAll(Iterable<? extends AutoCloseable> autoCloseables)	Binds all given AutoCloseable with this composite closable.
void	close()	Closes this composite resource.
default void	closeAndReportExceptions()	Closes this composite resource, but simply prints any resultant exceptions instead of rethrowing them.
default void	closeSilently()	Closes this composite resource, but doesn't rethrow or print any exceptions.
static CompositeAutoClosable	create()	Creates a new standalone CompositeAutoClosable.

Method Detail

create

static CompositeAutoClosable create()

Creates a new standalone CompositeAutoClosable.

Returns:

a new CompositeAutoClosable.

bind

CompositeAutoClosable bind(AutoCloseable autoCloseable)

Binds an AutoCloseable with this composite closable.

Note that implementations do not keep track of duplicate contains closables. If a single AutoCloseable is added twice, it will be closed twice.

Parameters:

autoCloseable - the closable to bind

Returns:

this (for chaining)

Throws:

NullPointerException - if the closable is null

bindAll

default CompositeAutoClosable bindAll(AutoCloseable... autoCloseables)

Binds all given AutoCloseable with this composite closable.

Note that implementations do not keep track of duplicate contains closables. If a single AutoCloseable is added twice, it will be closed twice.

Ignores null values.

Parameters:

autoCloseables - the closables to bind

Returns:

this (for chaining)

bindAll

default CompositeAutoClosable bindAll(Iterable<? extends AutoCloseable> autoCloseables)

Binds all given AutoCloseable with this composite closable.

Note that implementations do not keep track of duplicate contains closables. If a single AutoCloseable is added twice, it will be closed twice.

Ignores null values.

Parameters:

autoCloseables - the closables to bind

Returns:

this (for chaining)

close

void close()
    throws CompositeClosingException

Closes this composite resource.

Specified by:

close in interface AutoCloseable

Throws:

CompositeClosingException - if any of the sub instances throw an exception whilst closing

closeSilently

default void closeSilently()

Closes this composite resource, but doesn't rethrow or print any exceptions.

See Also:

close()

closeAndReportExceptions

default void closeAndReportExceptions()

Closes this composite resource, but simply prints any resultant exceptions instead of rethrowing them.

See Also:

close(), CompositeClosingException.printAllStackTraces()