Package com.e1c.g5.v8.dt.cli.api

Annotation Interface CliCommand

@Retention(RUNTIME) @Target(METHOD) public @interface CliCommand
Annotation to mark methods which represent CLI commands.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Command descriptor, i.e. either a help message or the variable name of the localized message from the respective NLS Messages class.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    command
    CLI command this method implements.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    UNSPECIFIED
    Special value which means a value is not provided.

  • Field Details

  • Element Details

    • value

      String value
      Command descriptor, i.e. either a help message or the variable name of the localized message from the respective NLS Messages class.

    • command

      String command
      CLI command this method implements. If not specified, the method name itself transformed into kebab-case will be the command name. Also, in this case, the following prefixes are removed from the method name, so you may use them to avoid restrictions on method names: _, get, set, is, get_, set_, is_, c0_ - c9_.
      Default:
      "com.e1c.g5.v8.dt.cli.api.unspecified.clicommand"