Package com.beust.jcommander
Annotation Type Parameters
-
@Retention(RUNTIME) @Target(TYPE) @Inherited public @interface Parameters
An annotation used to specify settings for parameter parsing.- Author:
- cbeust
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description 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.String
commandDescriptionKey
String[]
commandNames
An array of allowed command names.boolean
hidden
If true, this command won't appear in the usage().String
resourceBundle
The name of the resource bundle to use for this class.String
separators
The character(s) that separate options.
-
-
-
Element Detail
-
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 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:
- ""
-
-
-
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
-
-