Top Description Methods
org.kohsuke.args4j.spi

public Interface Parameters

Known Direct Implementers
org.kohsuke.args4j.CmdLineParser.CmdLineImpl
Imports
org.kohsuke.args4j.CmdLineException
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 TypeMethod and Description
public String

Returns:

Always return non-null valid String. If an attempt is made to access a non-existent index, this method throws appropriate org.kohsuke.args4j.CmdLineException.
getParameter(int
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.
idx)

Gets the additional parameter to this option.

public int
size()

Number of remaining tokens.

Method Detail

getParameterback to summary
public String getParameter(int idx) throws CmdLineException

Gets the additional parameter to this option.

Parameters
idx:int

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:String

Always return non-null valid String. If an attempt is made to access a non-existent index, this method throws appropriate org.kohsuke.args4j.CmdLineException.

sizeback to summary
public int size()

Number of remaining tokens.