public class StopOptionHandler extends OptionHandler<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 String> setter) |
Modifier and Type | Method and Description |
---|---|
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, getNameAndMeta, print, printDefaultValue
public StopOptionHandler(CmdLineParser parser, OptionDef option, Setter<? super String> setter)
public int parseArguments(Parameters params) throws CmdLineException
OptionHandler
parseArguments
in class OptionHandler<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.0
if this option doesn't take any parameters.)CmdLineException
public String getDefaultMetaVariable()
OptionHandler
ResourceBundle
, if one was passed to
CmdLineParser
.getDefaultMetaVariable
in class OptionHandler<String>
null
to hide a meta variable.Copyright © 2003-2016 Kohsuke Kawaguchi. All Rights Reserved.