Package org.kohsuke.args4j.spi
Class DelimitedOptionHandler<T>
java.lang.Object
org.kohsuke.args4j.spi.OptionHandler<T>
org.kohsuke.args4j.spi.DelimitedOptionHandler<T>
- Direct Known Subclasses:
MultiFileOptionHandler
,MultiPathOptionHandler
Partial
OptionHandler
implementation that takes a single value to the option,
which is then gets split into individual tokens using fixed delimiter.
This class is marked as abstract
even though it has no abstract methods
to indicate that the class cannot be used by itself in Option.handler()
,
due to the extra argument that it takes.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final String
protected final OneArgumentOptionHandler
<? extends T> Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
-
Constructor Summary
ConstructorsConstructorDescriptionDelimitedOptionHandler
(CmdLineParser parser, OptionDef option, Setter<? super T> setter, String delimiter, OneArgumentOptionHandler<? extends T> individualOptionHandler) -
Method Summary
Modifier and TypeMethodDescriptionGets the default meta variable name used to print the usage screen.int
parseArguments
(Parameters params) Called if the option that this owner recognizes is found.Prints the default value by introspecting the current setter asGetter
.Methods inherited from class org.kohsuke.args4j.spi.OptionHandler
getMetaVariable, getNameAndMeta, getNameAndMeta, print
-
Field Details
-
delimiter
-
individualOptionHandler
-
-
Constructor Details
-
DelimitedOptionHandler
public DelimitedOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super T> setter, String delimiter, OneArgumentOptionHandler<? extends T> individualOptionHandler)
-
-
Method Details
-
parseArguments
Description copied from class:OptionHandler
Called if the option that this owner recognizes is found.- Specified by:
parseArguments
in classOptionHandler<T>
- Parameters:
params
- 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.- Returns:
- The number of arguments consumed. (For example, returns
0
if this option doesn't take any parameters.) - Throws:
CmdLineException
-
getDefaultMetaVariable
Description copied from class:OptionHandler
Gets the default meta variable name used to print the usage screen. The value returned by this method can be a reference in theResourceBundle
, if one was passed toCmdLineParser
.- Specified by:
getDefaultMetaVariable
in classOptionHandler<T>
- Returns:
null
to hide a meta variable.
-
printDefaultValue
Prints the default value by introspecting the current setter asGetter
.- Overrides:
printDefaultValue
in classOptionHandler<T>
- Returns:
- null if the current value of the setter isn't available.
-