@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface Parameter
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 = true
|
boolean |
forceNonOverwritable |
If true, this parameter can be overwritten through a file or another appearance of the parameter
|
boolean |
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 |
String[] names
String description
String descriptionKey
int arity
boolean password
Class<? extends IStringConverter<?>> converter
Class<? extends IStringConverter<?>> listConverter
Class<? extends IParameterValidator>[] validateWith
Class<? extends IValueValidator>[] validateValueWith
boolean variableArity
Class<? extends IParameterSplitter> splitter
boolean echoInput
boolean help