Annotation Type Description


  • @Retention(RUNTIME)
    @Target(TYPE)
    @Documented
    public @interface Description
    An annotation with which a description of the command can be configured. Currently this description is used nowhere, but can for example be displayed in an own help command.

    Alternatively to using this annotation the Command.getDescription() method can be overwritten. If that method is overwritten and this annotation is used, the method overwrite takes precedence. That method is also what should be used to retrieve the configured description.

    See Also:
    Command.getDescription()
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      Returns the description of the annotated command.
    • Element Detail

      • value

        String value
        Returns the description of the annotated command.
        Returns:
        the description of the annotated command