org.apache.commons.cli
Interface CommandLineParser

All Known Implementing Classes:

BasicParser, GnuParser, Parser, PosixParser

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

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

Method Detail

parse

CommandLine parse(Options options,
                  String[] arguments)
                  throws ParseException

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

CommandLine parse(Options options,
                  String[] arguments,
                  Properties properties)
                  throws ParseException

Parse the arguments according to the specified options and properties.

Parameters:

options - the specified Options

arguments - the command line arguments

properties - command line option name-value pairs

Returns:

the list of atomic option and value tokens

Throws:

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

parse

CommandLine parse(Options options,
                  String[] arguments,
                  boolean stopAtNonOption)
                  throws ParseException

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.

parse

CommandLine parse(Options options,
                  String[] arguments,
                  Properties properties,
                  boolean stopAtNonOption)
                  throws ParseException

Parse the arguments according to the specified options and properties.

Parameters:

options - the specified Options

arguments - the command line arguments

properties - command line option name-value pairs

stopAtNonOption - specifies whether to continue parsing the

Returns:

the list of atomic option and value tokens

Throws:

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