me.lucko.helper.command

Interface Command

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

AbstractCommand

public interface Command
extends Terminable

Represents a command

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	call(CommandContext<?> context) Calls the command handler
void	register(ExtendedJavaPlugin plugin, String... aliases) Registers this command with the server, via the given plugin instance
default void	registerAndBind(TerminableConsumer consumer, ExtendedJavaPlugin plugin, String... aliases) Registers this command with the server, via the given plugin instance, and then binds it with the composite terminable.

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, close, hasTerminated, of, terminate

Method Detail

register

void register(@Nonnull
              ExtendedJavaPlugin plugin,
              @Nonnull
              String... aliases)

Registers this command with the server, via the given plugin instance

Parameters:

plugin - the plugin instance

aliases - the aliases for the command

registerAndBind

default void registerAndBind(@Nonnull
                             TerminableConsumer consumer,
                             @Nonnull
                             ExtendedJavaPlugin plugin,
                             @Nonnull
                             String... aliases)

Registers this command with the server, via the given plugin instance, and then binds it with the composite terminable.

Parameters:

consumer - the terminable consumer to bind with

plugin - the plugin instance

aliases - the aliases for the command

call

void call(@Nonnull
          CommandContext<?> context)
   throws CommandInterruptException

Calls the command handler

Parameters:

context - the contexts for the command

Throws:

CommandInterruptException