org.kohsuke.args4j.spi
Class RestOfArgumentsHandler

java.lang.Object
  extended by org.kohsuke.args4j.spi.OptionHandler<java.lang.String>
      extended by org.kohsuke.args4j.spi.RestOfArgumentsHandler

public class RestOfArgumentsHandler
extends OptionHandler<java.lang.String>

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
RestOfArgumentsHandler(CmdLineParser cmdLineParser, OptionDef optionDef, Setter<java.lang.String> setter)
           
 
Method Summary
 java.lang.String getDefaultMetaVariable()
          Gets 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RestOfArgumentsHandler

public RestOfArgumentsHandler(CmdLineParser cmdLineParser,
                              OptionDef optionDef,
                              Setter<java.lang.String> setter)
Method Detail

parseArguments

public int parseArguments(Parameters parameters)
                   throws CmdLineException
Description copied from class: OptionHandler
Called if the option that this owner recognizes is found.

Specified by:
parseArguments in class OptionHandler<java.lang.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, return 0 if this option doesn't take any parameter.
Throws:
CmdLineException

getDefaultMetaVariable

public java.lang.String getDefaultMetaVariable()
Description copied from class: OptionHandler
Gets the default meta variable name used to print the usage screen.

Specified by:
getDefaultMetaVariable in class OptionHandler<java.lang.String>
Returns:
null to hide a meta variable.


Copyright © 2003-2012 Kohsuke Kawaguchi. All Rights Reserved.