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
List<String>	callTabCompleter(CommandContext<?> context) Calls the command tab completer
void	register(String... aliases) Registers this command with the server, via the given plugin instance
default void	registerAndBind(TerminableConsumer consumer, 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, closeAndReportException, closeSilently, isClosed

Method Detail

register

void register(@Nonnull
              String... aliases)

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

Parameters:

aliases - the aliases for the command

registerAndBind

default void registerAndBind(@Nonnull
                             TerminableConsumer consumer,
                             @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

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

callTabCompleter

List<String> callTabCompleter(@Nonnull
                              CommandContext<?> context)
                       throws CommandInterruptException

Calls the command tab completer

Parameters:

context - the contexts for the command

Returns:

a List with the completions

Throws:

CommandInterruptException