Interface Command

All Known Subinterfaces:
BoxAdminCommand, BoxCommand
All Known Implementing Classes:
AbstractCommand
public interface Command
An interface of the command.

  • Method Details

    • getName

      @NotNull @NotNull String getName()
      Gets the command name.
      Returns:
      the command name

    • getPermissionNode

      @NotNull @NotNull String getPermissionNode()
      Gets the permission node.
      Returns:
      the permission node

    • getAliases

      @NotNull @NotNull @Unmodifiable Set<String> getAliases()
      Gets the set of aliases.
      Returns:
      the set of aliases

    • getHelp

      @NotNull @NotNull ComponentLike getHelp()
      Gets the helps.
      Returns:
      the helps

    • onCommand

      void onCommand(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String[] args)
      Executes the command.

      When this method is called, the executor has the permission and the length of the argument array is greater than or equal to 1.

      Parameters:
      sender - the executor
      args - the array of arguments

    • onTabComplete

      @NotNull @NotNull List<String> onTabComplete(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String[] args)
      Gets the tab-completion.

      When this method is called, the executor has the permission and the length of the argument array is greater than or equal to 1.

      Parameters:
      sender - the executor
      args - the array of arguments
      Returns:
      the result of the tab-completion or an empty list