me.lucko.helper.terminable

Interface Terminable

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

BaseHologram, BossBar, ChannelAgent<T>, Command, CompositeTerminable, ConversationChannel<T,R>, ConversationChannelAgent<T,R>, Hologram, IndividualHologram, MergedSubscription<T>, NpcFactory, Promise<V>, ProtocolSubscription, ServerThreadLock, SingleSubscription<T>, Subscription, Task

All Known Implementing Classes:

AbstractCommand, AbstractCompositeTerminable, AbstractWeakCompositeTerminable, ChannelPublisher, CitizensNpcFactory, MappedChannelReceiver, ServiceCallback, SimpleConversationChannel

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Terminable
extends AutoCloseable

An extension of AutoCloseable.

Field Summary

Fields

Modifier and Type	Field and Description
static Terminable	EMPTY

Method Summary

Modifier and Type	Method and Description
default void	bindWith(TerminableConsumer consumer) Binds this terminable with a terminable consumer
void	close() Closes this resource.
default void	closeAndReportException() Closes this resource, and prints the exception if one is thrown.
default Exception	closeSilently() Silently closes this resource, and returns the exception if one is thrown.
default boolean	isClosed() Gets if the object represented by this instance is already permanently closed.

Field Detail

EMPTY

static final Terminable EMPTY

Method Detail

close

void close()
    throws Exception

Closes this resource.

Specified by:

close in interface AutoCloseable

Throws:

Exception

isClosed

default boolean isClosed()

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

Returns:

true if this terminable is closed permanently

closeSilently

@Nullable
default Exception closeSilently()

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

Returns:

the exception is one is thrown

closeAndReportException

default void closeAndReportException()

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

bindWith

default void bindWith(@Nonnull
                      TerminableConsumer consumer)

Binds this terminable with a terminable consumer

Parameters:

consumer - the terminable consumer