me.lucko.helper.terminable

Interface Terminable

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

ChannelAgent<T>, Command, Hologram, MergedSubscription<T>, Promise<V>, Scheduler.Task, SingleSubscription<T>, Subscription, TerminableRegistry

All Known Implementing Classes:

AbstractCommand, ServiceCallback, SimpleTerminableRegistry

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

Represents an object that can be unregistered, stopped, or gracefully halted.

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) Registers this terminable with a terminable consumer (usually the plugin instance)
default void	close()
default boolean	hasTerminated() Used to help cleanup held terminable instances in registries
static Terminable	of(Runnable r)
boolean	terminate() Terminate this instance

Field Detail

EMPTY

static final Terminable EMPTY

Method Detail

of

@Nonnull
static Terminable of(@Nonnull
                               Runnable r)

terminate

boolean terminate()

Terminate this instance

Returns:

true if the termination was successful

bindWith

default void bindWith(@Nonnull
                      TerminableConsumer consumer)

Registers this terminable with a terminable consumer (usually the plugin instance)

Parameters:

consumer - the terminable consumer

hasTerminated

default boolean hasTerminated()

Used to help cleanup held terminable instances in registries

Returns:

true if this terminable has been terminated already

close

default void close()

Specified by:

close in interface AutoCloseable