Package org.incendo.cloud.description

Interface Description

@Immutable @API(status=STABLE) public interface Description
A description for a command or a command component.

  • Field Details

  • Method Details

    • empty

      static @NonNull Description empty()
      Returns an empty command description.
      Returns:
      Command description

    • of

      static @NonNull Description of(@NonNull String string)
      Creates a command description instance.
      Parameters:
      string - Command description
      Returns:
      Created command description

    • description

      static @NonNull Description description(@NonNull String string)
      Creates a command description instance.
      Parameters:
      string - Command description
      Returns:
      Created command description

    • textDescription

      @NonNull String textDescription()
      Returns the plain-text version of this description.

      If isEmpty() is true this will return an empty string.

      Returns:
      plain-text description

    • isEmpty

      default boolean isEmpty()
      Returns whether this description contains contents.
      Returns:
      true if the description is empty, or false if not