Interface Parameters

public interface Parameters
List of arguments.

Object of this interface is passed to OptionHandlers to make it easy/safe to parse additional parameters for options.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParameter(int idx)
    Gets the additional parameter to this option.
    int
    size()
    Number of remaining tokens.

  • Method Details

    • getParameter

      String getParameter(int idx) throws CmdLineException
      Gets the additional parameter to this option.
      Parameters:
      idx - specifying 0 will retrieve the token next to the option. For example, if the command line looks like -o abc -d x, then getParameter(0) for -o returns abc and getParameter(1) will return -d.
      Returns:
      Always return non-null valid String. If an attempt is made to access a non-existent index, this method throws appropriate CmdLineException.
      Throws:
      CmdLineException

    • size

      int size()
      Number of remaining tokens.