Package org.kohsuke.args4j
Annotation Interface Argument
Argument of the command line.
This works mostly like
Option
except the following differences.
- Arguments have an index about their relative position on the command line.
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass<? extends OptionHandler>
SeeOption.handler()
.boolean
SeeOption.hidden()
.int
Position of the argument.SeeOption.metaVar()
.boolean
boolean
SeeOption.required()
.SeeOption.usage()
.
-
Element Details
-
usage
String usageSeeOption.usage()
.- Default:
- ""
-
metaVar
String metaVarSeeOption.metaVar()
.- Default:
- ""
-
required
boolean requiredSeeOption.required()
.- Default:
- false
-
handler
Class<? extends OptionHandler> handlerSeeOption.handler()
.- Default:
- org.kohsuke.args4j.spi.OptionHandler.class
-
index
int indexPosition of the argument.If you define multiple single value properties to bind to arguments, they should have
index=0, index=1, index=2
, ... and so on.Multi value properties bound to arguments must be always the last entry.
- Default:
- 0
-
multiValued
boolean multiValued- Default:
- false
-