Package com.beust.jcommander
Annotation Type Parameters
-
@Retention(RUNTIME) @Target(TYPE) @Inherited public @interface Parameters
An annotation used to specify settings for parameter parsing.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String
commandDescription
If the annotated class was added toJCommander
as a command withJCommander.addCommand(java.lang.String, java.lang.Object)
, then this string will be displayed in the description whenJCommander.usage()
is invoked.java.lang.String
commandDescriptionKey
java.lang.String[]
commandNames
An array of allowed command names.boolean
hidden
If true, this command won't appear in the usage().java.lang.Class<? extends IParametersValidator>[]
parametersValidators
Validate the value for all parameters.java.lang.String
resourceBundle
The name of the resource bundle to use for this class.java.lang.String
separators
The character(s) that separate options.
-
-
-
-
commandDescription
java.lang.String commandDescription
If the annotated class was added toJCommander
as a command withJCommander.addCommand(java.lang.String, java.lang.Object)
, then this string will be displayed in the description whenJCommander.usage()
is invoked.- Default:
- ""
-
-
hidden
boolean hidden
If true, this command won't appear in the usage().- Default:
- false
-
-
-
parametersValidators
java.lang.Class<? extends IParametersValidator>[] parametersValidators
Validate the value for all parameters.- Default:
- {}
-
-