Annotation Type CommandLine.Parameters

Enclosing class:
CommandLine
@Retention(CLASS) @Target(FIELD) public static @interface CommandLine.Parameters
Marks a field that receives positional parameters.

  • Element Details

    • index

      String index
      The positions it takes: 0, 1..3, 1..*. Defaults to the next position, or the rest for an array or a list.
      Default:
      ""

    • description

      String[] description
      Help text.
      Default:
      {}

    • arity

      String arity
      How many values it takes.
      Default:
      ""

    • paramLabel

      String paramLabel
      The placeholder printed for it.
      Default:
      ""

    • defaultValue

      String defaultValue
      The value used when it is absent.
      Default:
      ""

    • split

      String split
      A separator that splits one value into several.
      Default:
      ""

    • hidden

      boolean hidden
      Leaves it out of the help.
      Default:
      false

    • converter

      Class<?> converter
      A converter for a type the build does not convert by itself.
      Default:
      void.class