Package dev.demeng.pluginbase.terminable.composite

Interface CompositeTerminable

All Superinterfaces:

AutoCloseable, Terminable, TerminableConsumer

All Known Implementing Classes:

AbstractCompositeTerminable, AbstractWeakCompositeTerminable

public interface CompositeTerminable
extends Terminable, TerminableConsumer

Represents a Terminable made up of several other Terminables.

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

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

Field Summary

Fields inherited from interface dev.demeng.pluginbase.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method	Description
default <T extends AutoCloseable> T	bind(T terminable)	Binds with the given terminable.
void	cleanup()	Removes instances which have already been terminated.
void	close()	Closes this composite terminable.
default void	closeAndReportException()	Closes this resource, and prints the exception if one is thrown.
default @Nullable CompositeClosingException	closeSilently()	Silently closes this resource, and returns the exception if one is thrown.
static @NotNull CompositeTerminable	create()	Creates a new standalone CompositeTerminable.
static @NotNull CompositeTerminable	createWeak()	Creates a new standalone CompositeTerminable, which wraps contained terminables in WeakReferences.
CompositeTerminable	with(AutoCloseable autoCloseable)	Binds an AutoCloseable with this composite closable.
default CompositeTerminable	withAll(AutoCloseable... autoCloseables)	Binds all given AutoCloseable with this composite closable.
default CompositeTerminable	withAll(Iterable<? extends AutoCloseable> autoCloseables)	Binds all given AutoCloseable with this composite closable.

Methods inherited from interface dev.demeng.pluginbase.terminable.Terminable

bindWith, isClosed

Methods inherited from interface dev.demeng.pluginbase.terminable.TerminableConsumer

bindModule

Method Details

create

@NotNull
static @NotNull CompositeTerminable create()

Creates a new standalone CompositeTerminable.

Returns:

a new CompositeTerminable

createWeak

@NotNull
static @NotNull CompositeTerminable createWeak()

Creates a new standalone CompositeTerminable, which wraps contained terminables in WeakReferences.

Returns:

a new CompositeTerminable

close

void close()
    throws CompositeClosingException

Closes this composite terminable.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable

Throws:

CompositeClosingException - if any of the sub-terminables throw an exception on close

closeSilently

@Nullable
default @Nullable CompositeClosingException closeSilently()

Description copied from interface: Terminable

Silently closes this resource, and returns the exception if one is thrown.

Specified by:

closeSilently in interface Terminable

Returns:

the exception is one is thrown

closeAndReportException

default void closeAndReportException()

Description copied from interface: Terminable

Closes this resource, and prints the exception if one is thrown.

Specified by:

closeAndReportException in interface Terminable

with

CompositeTerminable with(AutoCloseable autoCloseable)

Binds an AutoCloseable with this composite closable.

Note that implementations do not keep track of duplicate contained terminables. 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

withAll

default CompositeTerminable withAll(AutoCloseable... autoCloseables)

Binds all given AutoCloseable with this composite closable.

Note that implementations do not keep track of duplicate contained terminables. 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)

withAll

default CompositeTerminable withAll(Iterable<? extends AutoCloseable> autoCloseables)

Binds all given AutoCloseable with this composite closable.

Note that implementations do not keep track of duplicate contained terminables. 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)

bind

@NotNull
default <T extends AutoCloseable> T bind(@NotNull
 T terminable)

Description copied from interface: TerminableConsumer

Binds with the given terminable.

Specified by:

bind in interface TerminableConsumer

Type Parameters:

T - the terminable type

Parameters:

terminable - the terminable to bind with

Returns:

the same terminable

cleanup

void cleanup()

Removes instances which have already been terminated.