Module com.github.sttk.cliargs
Package com.github.sttk.cliargs.annotations

Annotation Interface Opt

@Retention(RUNTIME) @Target(FIELD) public @interface Opt
Is the annotation that is attached to fields of an option store class.

This annotation can specify values for the fields of an OptCfg object: names, defaults, desc and argInHelp.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    arg
    Gets the display of the option argument in a help text.
    String
    cfg
    Gets the option name, aliases and default values.
    String
    desc
    Gets the description of the option.

  • Element Details

    • cfg

      String cfg
      Gets the option name, aliases and default values.
      Returns:
      The option name, aliases and default values.
      Default:
      ""

    • desc

      String desc
      Gets the description of the option.
      Returns:
      The description of the option.
      Default:
      ""

    • arg

      String arg
      Gets the display of the option argument in a help text.
      Returns:
      The display of the option argument in a help text.
      Default:
      ""