Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.cli

Interface CommandLineParser

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.

Method Details

parse

public 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

public 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.

Package Class Use Tree Index Deprecated About