Annotation Type CommandUsage


  • @Documented
    @Retention(RUNTIME)
    @Target(TYPE)
    public @interface CommandUsage
    Represents a annotation, which represents usage of a Command. Should be annotated directly on the class implementing the parent command class like:

    Usage example:

    
    @CommandUsage("hello [world] (123)")
     public class MyCommand extends Command {
         // other code
     }

    tl;dr Make your command have a usage!

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      @NotNull java.lang.String value
      Represents the usage string.
    • Element Detail

      • value

        @NotNull
        @NotNull java.lang.String value
        Represents the usage string.
        Returns:
        usage