Annotation Type Command


  • @Target(TYPE)
    @Retention(RUNTIME)
    @Documented
    public @interface Command
    Marks a class as a command
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      Name of the command
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      Description of the command
      java.lang.String[] groupNames
      The group(s) this command should belong to.
      boolean hidden
      If true, this command won't appear in help
    • Element Detail

      • name

        java.lang.String name
        Name of the command
        Returns:
        Command name
      • description

        java.lang.String description
        Description of the command
        Returns:
        Command description
        Default:
        ""
      • hidden

        boolean hidden
        If true, this command won't appear in help
        Returns:
        Whether this command is hidden
        Default:
        false
      • groupNames

        java.lang.String[] groupNames
        The group(s) this command should belong to. if left empty the command will belong to the default command group

        If a group name contains spaces then this is interpreted as referring to a sub-group, for example foo bar would place this command into the bar group which would be placed as a sub-group of the foo group.

        Returns:
        Command groups
        Default:
        {}