Package com.codingchili.core.context

Interface Command

All Known Implementing Classes:
BaseCommand
public interface Command
A command that may be executed by the CommandExecutor.

  • Method Details

    • isVisible

      default boolean isVisible()
      Indicates if this command should be printed in the help dialog.
      Returns:
      true if the command should be listed in the help menu.

    • execute

      void execute​(io.vertx.core.Promise<CommandResult> promise, CommandExecutor executor)
      Executes a command.
      Parameters:
      promise - callback: complete with true to abort startup.
      executor - the executor executing the command, can be used to get properties.

    • getDescription

      String getDescription()
      Returns:
      the command description.

    • getName

      String getName()
      Returns:
      the name of the command.