Package com.beust.jcommander

Annotation Interface DynamicParameter

@Retention(RUNTIME) @Target(FIELD) public @interface DynamicParameter

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    assignment
    The character(s) used to assign the values.
    String
    category
    If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.
    String
    description
    A description of this option.
    String
    descriptionKey
    The key used to find the string in the message bundle.
    boolean
    hidden
    If true, this parameter won't appear in the usage().
    String[]
    names
    An array of allowed command line parameters (e.g.
    int
    order
    If specified, this number will be used to order the description of this parameter when usage() is invoked.
    boolean
    required
    Whether this option is required.
    Class<? extends IValueValidator>[]
    validateValueWith
     
    Class<? extends IParameterValidator>[]
    validateWith
    The validation classes to use.

  • Element Details

    • names

      String[] names
      An array of allowed command line parameters (e.g. "-D", "--define", etc...).
      Default:
      {}

    • required

      boolean required
      Whether this option is required.
      Default:
      false

    • description

      String description
      A description of this option.
      Default:
      ""

    • descriptionKey

      String descriptionKey
      The key used to find the string in the message bundle.
      Default:
      ""

    • hidden

      boolean hidden
      If true, this parameter won't appear in the usage().
      Default:
      false

    • validateWith

      Class<? extends IParameterValidator>[] validateWith
      The validation classes to use.
      Default:
      {com.beust.jcommander.validators.NoValidator.class}

    • assignment

      String assignment
      The character(s) used to assign the values.
      Default:
      "="

    • validateValueWith

      Class<? extends IValueValidator>[] validateValueWith
      Default:
      {com.beust.jcommander.validators.NoValueValidator.class}

    • order

      int order
      If specified, this number will be used to order the description of this parameter when usage() is invoked.
      Returns:
      Default:
      -1

    • category

      String category
      If specified, the category name will be used to order the description of this parameter when usage() is invoked before the number order() is used.
      Returns:
      (default or specified) category name
      Default:
      ""