Package org.kohsuke.args4j.spi
Class StringArrayOptionHandler
An OptionHandler
for greedily mapping a list of tokens into a collection of String
s
(such as String[]
, List<String>
, etc.).
How it works:
Example for parameter -s
, which is type String[]
:
java -jar aaa.jar -s banan hruska jablko
java -jar aaa.jar -s banan "hruska jablko"
java -jar aaa.jar -s "banan hruska jablko"
java -jar aaa.jar -s banan hruska jablko -l 4 -r
java -jar aaa.jar -t 222 -s banan hruska jablko -r
All of them result in a single string array that contains three tokens:
banan
, hruska
, and jablko
.
This OptionHandler
scans for parameter which begins with -. If found, it will stop.
-
Field Summary
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
-
Constructor Summary
ConstructorsConstructorDescriptionStringArrayOptionHandler
(CmdLineParser parser, OptionDef option, Setter<String> setter) -
Method Summary
Modifier and TypeMethodDescriptionReturns"STRING[]"
.int
parseArguments
(Parameters params) Tries to parseString[]
argument fromParameters
.Methods inherited from class org.kohsuke.args4j.spi.OptionHandler
getMetaVariable, getNameAndMeta, getNameAndMeta, print, printDefaultValue
-
Constructor Details
-
StringArrayOptionHandler
-
-
Method Details
-
getDefaultMetaVariable
Returns"STRING[]"
.- Specified by:
getDefaultMetaVariable
in classOptionHandler<String>
- Returns:
- return "STRING[]";
-
parseArguments
Tries to parseString[]
argument fromParameters
.- Specified by:
parseArguments
in classOptionHandler<String>
- 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
-