Package org.incendo.cloud.internal

Interface CommandRegistrationHandler<C>

Type Parameters:
C - command sender type
All Known Implementing Classes:
CommandRegistrationHandler.NullCommandRegistrationHandler
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @API(status=STABLE) public interface CommandRegistrationHandler<C>
Utility that registers commands natively for whatever platform the library is used in. This can do nothing, if the target platform does not have its own concept of commands

  • Method Details

    • nullCommandRegistrationHandler

      static <C> @NonNull CommandRegistrationHandler<C> nullCommandRegistrationHandler()
      Create a new CommandRegistrationHandler that does nothing
      Type Parameters:
      C - command sender type
      Returns:
      Constructed registration

    • registerCommand

      boolean registerCommand(@NonNull Command<C> command)
      Attempt to register the command
      Parameters:
      command - Command to register
      Returns:
      true if the command was registered successfully, else false

    • unregisterRootCommand

      @API(status=STABLE) default void unregisterRootCommand(@NonNull CommandComponent<C> rootCommand)
      Requests that the given rootCommand should be unregistered.
      Parameters:
      rootCommand - The command to delete