component type of the field that this OptionHandler works with.
When I say "component", I mean a field that can hold multiple values
(such as Collection or array). This should refer to its component time.
Setter implementations abstract away multi-value-ness by allowing OptionHandler
to invoke its Setter#addValue(Object) multiple times.
This class can be extended by application to support additional Java datatypes in option operands.
Implementation of this class needs to be registered to args4j by using
OptionHandlerRegistry#registerHandler(Class, Class).
For registration to work, subclasses will need to implement the constructor
with the signature
OptionHandler#OptionHandler(CmdLineParser, OptionDef, Setter).
| Modifier and Type | Field and Description |
|---|---|
| public final OptionDef | option
The annotation. |
| public final CmdLineParser | owner
The owner to which this handler belongs to. |
| public final Setter | setter
Object to be used for setting value. |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public abstract String | Returns: null to hide a meta variable.Gets the default meta variable name used to print the usage screen. |
| public String | |
| public final String | getNameAndMeta(ResourceBundle
ResourceBundle to get localized version of meta string rb)Get string representing usage for this option, of the form "name metaval", e.g. "-foo VALUE" or "--foo VALUE" |
| public final String | getNameAndMeta(ResourceBundle
ResourceBundle to get localized version of meta string rb, ParserProperties Affects the formatting behaviours. properties)Get string representing usage for this option, of the form "name metaval" or "name=metaval, e.g. "--foo VALUE" or "--foo=VALUE" |
| public abstract int | Returns: The number of arguments consumed. (For example, returns0
if this option doesn't take any parameters.)The rest of the arguments. This method can use this
object to access the arguments of the option if necessary.
The object is valid only during the method call. params)Called if the option that this owner recognizes is found. |
| protected String | |
| public String | Returns: null if the current value of the setter isn't available.Prints the default value by introspecting the current setter as |
| option | back to summary |
|---|---|
| public final OptionDef option The annotation. | |
| owner | back to summary |
|---|---|
| public final CmdLineParser owner The owner to which this handler belongs to. | |
| setter | back to summary |
|---|---|
| public final Setter<? super T> setter Object to be used for setting value. | |
| OptionHandler | back to summary |
|---|---|
| protected OptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter) | |
| getDefaultMetaVariable | back to summary |
|---|---|
| public abstract String getDefaultMetaVariable() Gets the default meta variable name used to print the usage screen.
The value returned by this method can be a reference in the
| |
| getMetaVariable | back to summary |
|---|---|
| public String getMetaVariable(ResourceBundle rb) | |
| getNameAndMeta | back to summary |
|---|---|
| public final String getNameAndMeta(ResourceBundle rb) Get string representing usage for this option, of the form "name metaval", e.g. "-foo VALUE" or "--foo VALUE"
| |
| getNameAndMeta | back to summary |
|---|---|
| public final String getNameAndMeta(ResourceBundle rb, ParserProperties properties) Get string representing usage for this option, of the form "name metaval" or "name=metaval, e.g. "--foo VALUE" or "--foo=VALUE"
| |
| parseArguments | back to summary |
|---|---|
| public abstract int parseArguments(Parameters params) throws CmdLineException Called if the option that this owner recognizes is found.
| |
| back to summary | |
|---|---|
| protected String print(T v) The opposite of the parse operation. This method is used to print the usage screen. | |
| printDefaultValue | back to summary |
|---|---|
| public String printDefaultValue() Prints the default value by introspecting the current setter as
| |