org.kohsuke.args4j.spi
public class StopOptionHandler extends OptionHandler<java.lang.String>
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"}.
option, owner, setter
Constructor and Description |
---|
StopOptionHandler(CmdLineParser parser,
OptionDef option,
Setter<? super java.lang.String> setter) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDefaultMetaVariable()
Gets 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.
|
getMetaVariable, getNameAndMeta
public StopOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super java.lang.String> setter)
public int parseArguments(Parameters params) throws CmdLineException
OptionHandler
parseArguments
in class OptionHandler<java.lang.String>
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.CmdLineException
public java.lang.String getDefaultMetaVariable()
OptionHandler
getDefaultMetaVariable
in class OptionHandler<java.lang.String>
Copyright © 2003-2014 Kohsuke Kawaguchi. All Rights Reserved.