org.apache.commons.cli
Class Parser

java.lang.Object
  org.apache.commons.cli.Parser

All Implemented Interfaces:

CommandLineParser

Direct Known Subclasses:

BasicParser, GnuParser, PosixParser

public abstract class Parser
extends Object
implements CommandLineParser

Parser creates CommandLines.

Version:

$Revision: 680644 $, $Date: 2008-07-29 01:13:48 -0700 (Tue, 29 Jul 2008) $

Author:

John Keyes (john at integralsource.com)

Field Summary

protected CommandLine

cmd commandline instance

Constructor Summary

Parser()

Method Summary

protected void	checkRequiredOptions() Throws a MissingOptionException if all of the required options are not 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.
protected Options	getOptions()
protected List	getRequiredOptions()
CommandLine	parse(Options options, String[] arguments) Parses the specified arguments based on the specifed Options.
CommandLine	parse(Options options, String[] arguments, boolean stopAtNonOption) Parses the specified arguments based on the specifed 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.
void	processArgs(Option opt, ListIterator iter) Process the argument values for the specified Option opt using the values retrieved from the specified iterator iter.
protected void	processOption(String arg, ListIterator iter) Process the Option specified by arg using the values retrieved from the specfied iterator iter.
protected void	processProperties(Properties properties) Sets the values of Options using the values in properties.
protected void	setOptions(Options options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cmd

protected CommandLine cmd

commandline instance

Constructor Detail

Parser

public Parser()

Method Detail

setOptions

protected void setOptions(Options options)

getOptions

protected Options getOptions()

getRequiredOptions

protected List getRequiredOptions()

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.

arguments - The arguments that have to be flattened.

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

Since:

1.1

parse

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

Parses the specified arguments based on the specifed Options.

Specified by:

parse in interface CommandLineParser

Parameters:

options - the Options

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.

parse

public 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 - stop parsing the arguments when the first 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.

Since:

1.1

processProperties

protected void processProperties(Properties properties)

Sets the values of Options using the values in properties.

Parameters:

properties - The value properties to be processed.

checkRequiredOptions

protected void checkRequiredOptions()
                             throws MissingOptionException

Throws a MissingOptionException if all of the required options are not present.

Throws:

MissingOptionException - if any of the required Options are not present.

processArgs

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

Process the argument values for the specified Option opt using the values retrieved from the specified iterator iter.

Parameters:

opt - The current Option

iter - The iterator over the flattened command line Options.

Throws:

ParseException - if an argument value is required and it is has not been found.

processOption

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

Process the Option specified by arg using the values retrieved from the specfied iterator iter.

Parameters:

arg - The String value representing an Option

iter - The iterator over the flattened command line arguments.

Throws:

ParseException - if arg does not represent an Option