Package org.kohsuke.args4j.spi
Class RestOfArgumentsHandler
Eagerly grabs all the arguments.
Used with Argument
, this implements a semantics where
non-option token causes the option parsing to terminate.
An example of this is ssh(1), where ssh -p 222 abc
will treat
-p
as an option to ssh, but ssh abc -p 222
is
considered to have no option for ssh.
- Author:
- Kohsuke Kawaguchi
-
Field Summary
Fields inherited from class org.kohsuke.args4j.spi.OptionHandler
option, owner, setter
-
Constructor Summary
ConstructorsConstructorDescriptionRestOfArgumentsHandler
(CmdLineParser cmdLineParser, OptionDef optionDef, Setter<String> setter) -
Method Summary
Modifier and TypeMethodDescriptionGets the default meta variable name used to print the usage screen.int
parseArguments
(Parameters parameters) 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
-
RestOfArgumentsHandler
public RestOfArgumentsHandler(CmdLineParser cmdLineParser, OptionDef optionDef, Setter<String> setter)
-
-
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:
parameters
- 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.
-