Annotation Type Command


  • @Retention(RUNTIME)
    @Target(TYPE)
    public @interface Command
    Annotation to document a TextBuiltin.

    This is an optional annotation for TextBuiltin subclasses and it carries documentation forward into the runtime system describing what the command is and why users may want to invoke it.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean common
      If this command is considered to be commonly used
      String name
      Get the command name
      String usage
      Get command description
    • Element Detail

      • name

        String name
        Get the command name
        Returns:
        name the command is invoked as from the command line. If the (default) empty string is supplied the name will be generated from the class name.
        Default:
        ""
      • usage

        String usage
        Get command description
        Returns:
        one line description of the command's feature set.
        Default:
        ""
      • common

        boolean common
        If this command is considered to be commonly used
        Returns:
        true if this command is considered to be commonly used.
        Default:
        false