Class RestOfArgumentsHandler

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

public class RestOfArgumentsHandler extends OptionHandler<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.

  • Constructor Details

  • Method Details

    • 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<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

      public String 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 the ResourceBundle, if one was passed to CmdLineParser.
      Specified by:
      getDefaultMetaVariable in class OptionHandler<String>
      Returns:
      null to hide a meta variable.