Package cloud.commandframework

Interface ArgumentDescription

All Known Implementing Classes:
Description
@API(status=STABLE, since="1.4.0") public interface ArgumentDescription
A description for a CommandArgument
Since:
1.4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NonNull ArgumentDescription
    empty()
    Get an empty command description.
    @NonNull String
    getDescription()
    Get the plain-text description.
    default boolean
    isEmpty()
    Get whether or not this description contains contents.
    static @NonNull ArgumentDescription
    of(@NonNull String string)
    Create a command description instance.

  • Method Details

    • empty

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

    • of

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

    • getDescription

      @NonNull String getDescription()
      Get the plain-text description.
      Returns:
      Command description

    • isEmpty

      default boolean isEmpty()
      Get whether or not this description contains contents.
      Returns:
      if this description is empty or not