Alphabetical Index

Add left-over unrecognized option/argument.

Add an option to the command line.

add opt to this group

Adds an option instance

Add an option that only contains a short-name

It may be specified as requiring an argument.

Add an option that contains a short-name and a long-name

It may be specified as requiring an argument.

Add the specified option group.

Adds the specified value to this Option.

Thrown when more than one option in an option group has been provided.

Construct a new AlreadySelectedException with the specified detail message.

argName specifies the name of the argument for this option

argument name

the unrecognised options/arguments

The class BasicParser provides a very simple implementation of the flatten method.

Breaks token into its constituent parts using the following algorithm.

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

Class class

commandline instance

Represents list of arguments parsed against a Options descriptor.

Creates a command line.

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

Create an Option using the current settings

Create an Option using the current settings and with the specified Option char.

Create an Option using the current settings and with the specified Option char.

Returns the class whose name is str.

Returns the date represented by str.

Returns the File represented by str.

Returns the File[] represented by str.

Create a number from a String.

Create an Object from the classname and empty constructor.

Returns the URL represented by str.

Returns the Object of type clazz with the value of str.

Returns the Object of type obj with the value of str.

holder for the current option

Date class

description of the option

option description

specifies if bursting should continue

FileInputStream class

File class

File array class

Finds the next text wrap position after startPos for the text in sb with the column width width.

A simple implementation of Parser's abstract flatten method.

This flatten method does so using the following rules:

1. If an Option exists for the first character of the arguments entry AND an Option does not exist for the whole argument then add the first character as an option to the processed tokens list e.g.

Subclasses must implement this method to reduce the arguments that have been passed to the parse method.

An implementation of Parser's abstract flatten method.

Retrieve any left-over non-recognized options and arguments

Gets the display name for the argument value.

Retrieve any left-over non-recognized options and arguments

Returns the number of argument values this Option can take.

Retrieve the self-documenting description of this Option

Returns the id of this Option.

Retrieve the long name of this Option.

Retrieve the name of this Option.

Retrieve the named Option

Returns the OptionGroup the opt belongs to.

Return the Object type of this Option.

Return the Object type of this Option.

Returns an array of the processed Options.

Retrieve a read-only list of options in this set

Retrieve the argument, if any, of this option.

Retrieve the argument, if any, of an option.

Retrieve the argument, if any, of this option.

Retrieve the argument, if any, of an option.

Retrieves the array of values, if any, of an option.

Retrieves the array of values, if any, of an option.

Returns the required options as a java.util.Collection.

Retrieve the type of this Option.

Retrieve the class that ch represents.

Returns the value separator character.

The class GnuParser provides an implementation of the flatten method.

Adds the remaining tokens to the processed tokens list.

hasArg specifies whether this option has an associated argument

Query to see if this Option requires an argument

The next Option created will require an argument value.

The next Option created will require an argument value if hasArg is true.

Returns whether the display name for the argument value has been set.

Query to see if this Option can take many values

The next Option created can have unlimited argument values.

The next Option created can have num argument values.

Map of unique options for ease to get complete list of options

Query to see if this Option has a long name

Query to see if an option has been set.

Query to see if an option has been set.

Returns whether the named Option is a member of this Options

The next Option can have an optional argument.

The next Option can have an unlimited number of optional arguments.

The next Option can have the specified number of optional arguments.

A formatter of help messages for the current command line options

Returns the Options for use by the HelpFormatter.

option char (only valid for single character options)

Resets the members to their original state i.e.

Resets the members to their original state i.e.

option builder instance

Query to see if this Option requires an argument

The next Option created will be required.

Returns whether this option group is required.

The next Option created will be required if required is true.

Returns whether the specified character is a valid character.

Returns whether the specified character is a valid Option.

Returns whether ch is a value code, i.e.

Returns an iterator over the Option members of CommandLine.

longOpt is the long representation of the option

long option

a map of the options with the long key

Thrown when an option requiring an argument is not provided with an argument.

Construct a new MissingArgumentException with the specified detail message.

Thrown when a required option has not been provided.

Construct a new MissingSelectedException with the specified detail message.

Number class

numberOfArgs specifies the number of argument values this option can have

the number of arguments

Object class

opt the single character representation of the option

Describes a single command-line option.

Creates an Option using the specified parameters.

Creates an Option using the specified parameters.

Creates an Option using the specified parameters.

specifies whether the argument value of this Option is optional

option can have an optional argument value

OptionBuilder allows the user to create Options using descriptive methods.

A group of mutually exclusive options.

a map of the option groups

hold the options

the processed options

Main entry-point into the library.

current Options

the command line Options

Construct a new Options descriptor

the processed options

Commons CLI 1.0

Parse the arguments according to the specified options.

Parses the specified arguments based on the specifed Options.

Parse the arguments according to the specified options.

Parses the specified arguments based on the specifed Options.

Base for Exceptions thrown during parsing of a command-line.

Construct a new ParseException with the specified detail message.

Returns the Options instance represented by pattern.

Parser creates CommandLines.

Allows Options to be created from a single String.

The class PosixParser provides an implementation of the flatten method.

Prints the usage statement for the specified application.

If there is a current option and it can have an argument value then add the token to the processed tokens list and set the current option to null.

If an Option exists for token then set the current option and add the token to the processed list.

If it is a hyphen then add the hyphen directly to the processed tokens list.

required specifies whether this option is required to be present

is required?

specified whether this group is required

list of required options strings

a map of the required options

Resets the member variables to their default values.

the name of the selected option

Sets the display name for the argument value.

Sets the number of argument values this Option can take.

Sets the long name of this Option.

Sets whether this Option can have an optional argument.

Sets whether this Option is mandatory.

set the selected option of this group to name.

Sets the type of this Option.

Sets the value separator.

a map of the options with the character key

String class

holder for flattened tokens

holder for flattened tokens

Dump state, suitable for debugging.

Returns the stringified version of this OptionGroup.

Dump state, suitable for debugging.

the type of this Option

option type

This is a temporary implementation.

constant that specifies the number of argument values has not been specified

constant that specifies the number of argument values is infinite

Exception thrown during parsing signalling an unrecognized option was seen.

Construct a new UnrecognizedArgumentException with the specified detail message.

URL class

Validates whether opt is a permissable Option shortOpt.

the list of argument values *

the character that is the value separator

value separator for argument value

The next Option created will have the specified argument value name.

The next Option created will have the specified description

The next Option created will have the following long option value.

The next Option created will have a value that will be an instance of type.

The next Option created uses '=' as a means to separate argument values.

The next Option created uses sep as a means to separate argument values.