Annotation Type Parameters

@Retention(RUNTIME) @Target(TYPE) @Inherited public @interface Parameters
An annotation used to specify settings for parameter parsing.
Author:
cbeust

  • Element Details

    • resourceBundle

      String resourceBundle
      The name of the resource bundle to use for this class.
      Default:
      ""

    • separators

      String separators
      The character(s) that separate options.
      Default:
      " "

    • commandDescription

      String commandDescription
      If the annotated class was added to JCommander as a command with JCommander.addCommand(String, Object), then this string will be displayed in the description when JCommander.usage() is invoked.
      Default:
      ""

    • commandDescriptionKey

      String commandDescriptionKey
      Returns:
      the key used to find the command description in the resource bundle.
      Default:
      ""

    • commandNames

      String[] commandNames
      An array of allowed command names.
      Default:
      {}

    • hidden

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

    • parametersValidators

      Class<? extends IParametersValidator>[] parametersValidators
      Validate the value for all parameters.
      Default:
      {}