Package org.kohsuke.args4j.spi
Class StopOptionHandler
OptionHandler
for the option terminator --.
This OptionHandler
can be used to implement the special token
-- that indicates that the rest of tokens are not options, but arguments.
For example, if you have the following class:
class Foo {
@Argument
@Option(name="--",handler=StopOptionHandler
.class)
List<String> args;
@Option(name="-n")
int n;
}
The command line -n 5 abc def
would parse into n=5, args={"abc",def"}
,
but -- -n 5 abc def
would parse into n=0, args={"-n","5","abc","def"}
.
- Author:
- Kohsuke Kawaguchi
-
Field Summary
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
-
Constructor Summary
ConstructorsConstructorDescriptionStopOptionHandler
(CmdLineParser parser, OptionDef option, Setter<? super String> setter) -
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.Methods inherited from class org.kohsuke.args4j.spi.OptionHandler
getMetaVariable, getNameAndMeta, getNameAndMeta, print, printDefaultValue
-
Constructor Details
-
StopOptionHandler
-
-
Method Details
-
parseArguments
Description copied from class:OptionHandler
Called if the option that this owner recognizes is found.- 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
-
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<String>
- Returns:
null
to hide a meta variable.
-