Package org.incendo.cloud.annotations.descriptor

Interface CommandDescriptor

All Superinterfaces:
Descriptor
All Known Implementing Classes:
ImmutableCommandDescriptor
@Immutable @API(status=STABLE) public interface CommandDescriptor extends Descriptor

  • Method Details

    • method

      @NonNull Method method()
      Returns the command method.
      Returns:
      the command method

    • name

      default @NonNull String name()
      Description copied from interface: Descriptor
      Returns the name of the object described by this descriptor.
      Specified by:
      name in interface Descriptor
      Returns:
      the name

    • syntax

      @NonNull List<@NonNull SyntaxFragment> syntax()
      Returns an unmodifiable view of the syntax fragments.
      Returns:
      the syntax fragments

    • commandToken

      @NonNull String commandToken()
      Returns the root command name.
      Returns:
      the name of the root command

    • requiredSender

      @NonNull Class<?> requiredSender()
      Returns the required sender type.
      Returns:
      the required sender type