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

Class Parser

Implemented Interfaces:
CommandLineParser
Known Direct Subclasses:
BasicParser, GnuParser, PosixParser
public abstract class Parser
extends Object
implements CommandLineParser
Parser creates CommandLines.
Version:
$Revision: 1.7 $
Author:
John Keyes (john at integralsource.com)
See Also:
Parser

Field Summary

private CommandLine
cmd
commandline instance
private Options
options
current Options
private List
requiredOptions
list of required options strings

Method Summary

private void
checkRequiredOptions()
Throws a MissingOptionException if all of the required options are no present.
protected abstract String[]
flatten(Options opts, String[] arguments, boolean stopAtNonOption)
Subclasses must implement this method to reduce the arguments that have been passed to the parse method.
CommandLine
parse(Options options, String[] arguments)
Parses the specified arguments based on the specifed Options.
CommandLine
parse(Options opts, String[] arguments, boolean stopAtNonOption)
Parses the specified arguments based on the specifed Options.
void
processArgs(Option opt, ListIterator iter)
private void
processOption(String arg, ListIterator iter)

Field Details

cmd

private CommandLine cmd
commandline instance

options

private Options options
current Options

requiredOptions

private List requiredOptions
list of required options strings

Method Details

checkRequiredOptions

private void checkRequiredOptions()
            throws MissingOptionException
Throws a MissingOptionException if all of the required options are no present.

flatten

protected abstract String[] flatten(Options opts,
                                    String[] arguments,
                                    boolean stopAtNonOption)
Subclasses must implement this method to reduce the arguments that have been passed to the parse method.
Parameters:
opts - The Options to parse the arguments by.
stopAtNonOption - specifies whether to stop flattening when a non option has been encountered
Returns:
a String array of the flattened arguments

parse

public CommandLine parse(Options options,
                         String[] arguments)
            throws ParseException
Parses the specified arguments based on the specifed Options.
Specified by:
parse in interface CommandLineParser
Parameters:
options - the Options
arguments - the arguments
Returns:
the CommandLine
Throws:
ParseException - if an error occurs when parsing the arguments.

parse

public CommandLine parse(Options opts,
                         String[] arguments,
                         boolean stopAtNonOption)
            throws ParseException
Parses the specified arguments based on the specifed Options.
Specified by:
parse in interface CommandLineParser
Parameters:
arguments - the arguments
stopAtNonOption - specifies whether to stop interpreting the arguments when a non option has been encountered and to add them to the CommandLines args list.
Returns:
the CommandLine
Throws:
ParseException - if an error occurs when parsing the arguments.

processArgs

public void processArgs(Option opt,
                        ListIterator iter)
            throws ParseException

processOption

private void processOption(String arg,
                           ListIterator iter)
            throws ParseException

Package Class Use Tree Index Deprecated About