Package dev.demeng.pluginbase.terminable.composite

Class AbstractCompositeTerminable

java.lang.Object

dev.demeng.pluginbase.terminable.composite.AbstractCompositeTerminable

All Implemented Interfaces:

CompositeTerminable, Terminable, TerminableConsumer, AutoCloseable

public class AbstractCompositeTerminable
extends Object
implements CompositeTerminable

Field Summary

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCompositeTerminable()

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Removes instances which have already been terminated.
void	close()	Closes this composite terminable.
boolean	isClosed()	Gets if the object represented by this instance is already permanently closed.
CompositeTerminable	with(AutoCloseable autoCloseable)	Binds an AutoCloseable with this composite closable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.demeng.pluginbase.terminable.composite.CompositeTerminable

bind, closeAndReportException, closeSilently, withAll, withAll

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

bindWith

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

bindModule

Constructor Details

AbstractCompositeTerminable

protected AbstractCompositeTerminable()

Method Details

with

public CompositeTerminable with(AutoCloseable autoCloseable)

Description copied from interface: CompositeTerminable

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.

Specified by:

with in interface CompositeTerminable

Parameters:

autoCloseable - the closable to bind

Returns:

this (for chaining)

close

public void close()
           throws CompositeClosingException

Description copied from interface: CompositeTerminable

Closes this composite terminable.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CompositeTerminable

Specified by:

close in interface Terminable

Throws:

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

isClosed

public boolean isClosed()

Description copied from interface: Terminable

Gets if the object represented by this instance is already permanently closed.

Specified by:

isClosed in interface Terminable

Returns:

true if this terminable is closed permanently

cleanup

public void cleanup()

Description copied from interface: CompositeTerminable

Removes instances which have already been terminated.

Specified by:

cleanup in interface CompositeTerminable