org.apache.commons.cli

Interface CommandLineParser

public interface CommandLineParser

A class that implements the CommandLineParser interface can parse a String array according to the Options specified and return a CommandLine.

Author: John Keyes (john at integralsource.com)

Method Summary
CommandLineparse(Options options, String[] arguments)
Parse the arguments according to the specified options.
CommandLineparse(Options options, String[] arguments, boolean stopAtNonOption)
Parse the arguments according to the specified options.

Method Detail

parse

public CommandLine parse(Options options, String[] arguments)
Parse the arguments according to the specified options.

Parameters: options the specified Options arguments the command line arguments

Returns: the list of atomic option and value tokens

Throws: ParseException if there are any problems encountered while parsing the command line tokens.

parse

public CommandLine parse(Options options, String[] arguments, boolean stopAtNonOption)
Parse the arguments according to the specified options.

Parameters: options the specified Options arguments the command line arguments stopAtNonOption specifies whether to continue parsing the arguments if a non option is encountered.

Returns: the list of atomic option and value tokens

Throws: ParseException if there are any problems encountered while parsing the command line tokens.