Package com.beust.jcommander
Annotation Type Parameter
-
@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface Parameter
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description int
arity
How many parameter values this parameter will consume.Class<? extends IStringConverter<?>>
converter
The string converter to use for this field.String
description
A description of this option.String
descriptionKey
The key used to find the string in the message bundle.boolean
echoInput
If true, console will not echo typed input Used in conjunction with password = trueboolean
forceNonOverwritable
If true, this parameter can be overwritten through a file or another appearance of the parameterboolean
help
If true, this parameter is for help.boolean
hidden
If true, this parameter won't appear in the usage().Class<? extends IStringConverter<?>>
listConverter
The list string converter to use for this field.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
password
If true, this parameter is a password and it will be prompted on the console (if available).boolean
required
Whether this option is required.Class<? extends IParameterSplitter>
splitter
What splitter to use (applicable only on fields of type List).Class<? extends IValueValidator>[]
validateValueWith
Validate the value for this parameter.Class<? extends IParameterValidator>[]
validateWith
Validate the parameter found on the command line.boolean
variableArity
-
-
-
Element Detail
-
names
String[] names
An array of allowed command line parameters (e.g. "-d", "--outputdir", etc...). If this attribute is omitted, the field it's annotating will receive all the unparsed options. There can only be at most one such annotation.- Default:
- {}
-
-
-
description
String description
A description of this option.- Default:
- ""
-
-
-
descriptionKey
String descriptionKey
The key used to find the string in the message bundle.- Default:
- ""
-
-
-
converter
Class<? extends IStringConverter<?>> converter
The string converter to use for this field. If the field is of type List and not listConverter attribute was specified, JCommander will split the input in individual values and convert each of them separately.- Default:
- com.beust.jcommander.converters.NoConverter.class
-
-
-
listConverter
Class<? extends IStringConverter<?>> listConverter
The list string converter to use for this field. If it's specified, the field has to be of type List and the converter needs to return a List that's compatible with that type.- Default:
- com.beust.jcommander.converters.NoConverter.class
-
-
hidden
boolean hidden
If true, this parameter won't appear in the usage().- Default:
- false
-
-
-
validateWith
Class<? extends IParameterValidator>[] validateWith
Validate the parameter found on the command line.- Default:
- {com.beust.jcommander.validators.NoValidator.class}
-
-
-
validateValueWith
Class<? extends IValueValidator>[] validateValueWith
Validate the value for this parameter.- Default:
- {com.beust.jcommander.validators.NoValueValidator.class}
-
-
-
splitter
Class<? extends IParameterSplitter> splitter
What splitter to use (applicable only on fields of type List). By default, a comma separated splitter will be used.- Default:
- com.beust.jcommander.converters.CommaParameterSplitter.class
-
-