A B C D E F G H I L M N O P R S T U V W

A

AlreadySelectedException - exception org.apache.commons.cli.AlreadySelectedException.

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

AlreadySelectedException(String) - Constructor for class org.apache.commons.cli.AlreadySelectedException

Construct a new AlreadySelectedException with the specified detail message.

addArg(String) - Method in class org.apache.commons.cli.CommandLine

Add left-over unrecognized option/argument.

addOption(Option) - Method in class org.apache.commons.cli.CommandLine

Add an option to the command line.

addOption(Option) - Method in class org.apache.commons.cli.OptionGroup

add opt to this group

addOption(String, boolean, String) - Method in class org.apache.commons.cli.Options

Add an option that only contains a short-name

addOption(String, String, boolean, String) - Method in class org.apache.commons.cli.Options

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

addOption(Option) - Method in class org.apache.commons.cli.Options

Adds an option instance

addOptionGroup(OptionGroup) - Method in class org.apache.commons.cli.Options

Add the specified option group.

addValue(String) - Method in class org.apache.commons.cli.Option

Adds the specified value to this Option.

argName - Variable in class org.apache.commons.cli.Option

argName specifies the name of the argument for this option

argName - Static variable in class org.apache.commons.cli.OptionBuilder

argument name

args - Variable in class org.apache.commons.cli.CommandLine

the unrecognised options/arguments

B

BasicParser - class org.apache.commons.cli.BasicParser.

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

BasicParser() - Constructor for class org.apache.commons.cli.BasicParser

burstToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser

Breaks token into its constituent parts using the following algorithm.

C

CLASS_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

Class class

CommandLine - class org.apache.commons.cli.CommandLine.

Represents list of arguments parsed against a Options descriptor.

CommandLine() - Constructor for class org.apache.commons.cli.CommandLine

Creates a command line.

CommandLineParser - interface org.apache.commons.cli.CommandLineParser.

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

checkRequiredOptions() - Method in class org.apache.commons.cli.Parser

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

clone() - Method in class org.apache.commons.cli.Option

cmd - Variable in class org.apache.commons.cli.Parser

commandline instance

compare(Object, Object) - Method in class org.apache.commons.cli.HelpFormatter.StringBufferComparator

create(char) - Static method in class org.apache.commons.cli.OptionBuilder

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

create() - Static method in class org.apache.commons.cli.OptionBuilder

Create an Option using the current settings

create(String) - Static method in class org.apache.commons.cli.OptionBuilder

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

createClass(String) - Static method in class org.apache.commons.cli.TypeHandler

Returns the class whose name is str.

createDate(String) - Static method in class org.apache.commons.cli.TypeHandler

Returns the date represented by str.

createFile(String) - Static method in class org.apache.commons.cli.TypeHandler

Returns the File represented by str.

createFiles(String) - Static method in class org.apache.commons.cli.TypeHandler

Returns the File[] represented by str.

createNumber(String) - Static method in class org.apache.commons.cli.TypeHandler

Create a number from a String.

createObject(String) - Static method in class org.apache.commons.cli.TypeHandler

Create an Object from the classname and empty constructor.

createPadding(int) - Method in class org.apache.commons.cli.HelpFormatter

createURL(String) - Static method in class org.apache.commons.cli.TypeHandler

Returns the URL represented by str.

createValue(String, Object) - Static method in class org.apache.commons.cli.TypeHandler

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

createValue(String, Class) - Static method in class org.apache.commons.cli.TypeHandler

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

currentOption - Variable in class org.apache.commons.cli.PosixParser

holder for the current option

D

DATE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

Date class

DEFAULT_ARG_NAME - Static variable in class org.apache.commons.cli.HelpFormatter

DEFAULT_DESC_PAD - Static variable in class org.apache.commons.cli.HelpFormatter

DEFAULT_LEFT_PAD - Static variable in class org.apache.commons.cli.HelpFormatter

DEFAULT_LONG_OPT_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter

DEFAULT_OPT_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter

DEFAULT_SYNTAX_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter

DEFAULT_WIDTH - Static variable in class org.apache.commons.cli.HelpFormatter

defaultArgName - Variable in class org.apache.commons.cli.HelpFormatter

defaultDescPad - Variable in class org.apache.commons.cli.HelpFormatter

defaultLeftPad - Variable in class org.apache.commons.cli.HelpFormatter

defaultLongOptPrefix - Variable in class org.apache.commons.cli.HelpFormatter

defaultNewLine - Variable in class org.apache.commons.cli.HelpFormatter

defaultOptPrefix - Variable in class org.apache.commons.cli.HelpFormatter

defaultSyntaxPrefix - Variable in class org.apache.commons.cli.HelpFormatter

defaultWidth - Variable in class org.apache.commons.cli.HelpFormatter

description - Variable in class org.apache.commons.cli.Option

description of the option

description - Static variable in class org.apache.commons.cli.OptionBuilder

option description

E

EXISTING_FILE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

FileInputStream class

eatTheRest - Variable in class org.apache.commons.cli.PosixParser

specifies if bursting should continue

F

FILES_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

File array class

FILE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

File class

findWrapPos(String, int, int) - Method in class org.apache.commons.cli.HelpFormatter

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

flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.BasicParser

A simple implementation of Parser's abstract flatten method.

flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.GnuParser

This flatten method does so using the following rules: 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.

flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.Parser

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

flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.PosixParser

An implementation of Parser's abstract flatten method.

G

GnuParser - class org.apache.commons.cli.GnuParser.

The class GnuParser provides an implementation of the flatten method.

GnuParser() - Constructor for class org.apache.commons.cli.GnuParser

getArgList() - Method in class org.apache.commons.cli.CommandLine

Retrieve any left-over non-recognized options and arguments

getArgName() - Method in class org.apache.commons.cli.Option

Gets the display name for the argument value.

getArgs() - Method in class org.apache.commons.cli.CommandLine

Retrieve any left-over non-recognized options and arguments

getArgs() - Method in class org.apache.commons.cli.Option

Returns the number of argument values this Option can take.

getDescription() - Method in class org.apache.commons.cli.Option

Retrieve the self-documenting description of this Option

getId() - Method in class org.apache.commons.cli.Option

Returns the id of this Option.

getLongOpt() - Method in class org.apache.commons.cli.Option

Retrieve the long name of this Option.

getNames() - Method in class org.apache.commons.cli.OptionGroup

getOpt() - Method in class org.apache.commons.cli.Option

Retrieve the name of this Option.

getOption(String) - Method in class org.apache.commons.cli.Options

Retrieve the named Option

getOptionGroup(Option) - Method in class org.apache.commons.cli.Options

Returns the OptionGroup the opt belongs to.

getOptionObject(String) - Method in class org.apache.commons.cli.CommandLine

Return the Object type of this Option.

getOptionObject(char) - Method in class org.apache.commons.cli.CommandLine

Return the Object type of this Option.

getOptionValue(String) - Method in class org.apache.commons.cli.CommandLine

Retrieve the argument, if any, of this option.

getOptionValue(char) - Method in class org.apache.commons.cli.CommandLine

Retrieve the argument, if any, of this option.

getOptionValue(String, String) - Method in class org.apache.commons.cli.CommandLine

Retrieve the argument, if any, of an option.

getOptionValue(char, String) - Method in class org.apache.commons.cli.CommandLine

Retrieve the argument, if any, of an option.

getOptionValues(String) - Method in class org.apache.commons.cli.CommandLine

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

getOptionValues(char) - Method in class org.apache.commons.cli.CommandLine

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

getOptions() - Method in class org.apache.commons.cli.CommandLine

Returns an array of the processed Options.

getOptions() - Method in class org.apache.commons.cli.OptionGroup

getOptions() - Method in class org.apache.commons.cli.Options

Retrieve a read-only list of options in this set

getRequiredOptions() - Method in class org.apache.commons.cli.Options

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

getSelected() - Method in class org.apache.commons.cli.OptionGroup

getType() - Method in class org.apache.commons.cli.Option

Retrieve the type of this Option.

getValue() - Method in class org.apache.commons.cli.Option

getValue(int) - Method in class org.apache.commons.cli.Option

getValue(String) - Method in class org.apache.commons.cli.Option

getValueClass(char) - Static method in class org.apache.commons.cli.PatternOptionBuilder

Retrieve the class that ch represents.

getValueSeparator() - Method in class org.apache.commons.cli.Option

Returns the value separator character.

getValues() - Method in class org.apache.commons.cli.Option

getValuesList() - Method in class org.apache.commons.cli.Option

gobble(Iterator) - Method in class org.apache.commons.cli.PosixParser

Adds the remaining tokens to the processed tokens list.

H

HelpFormatter - class org.apache.commons.cli.HelpFormatter.

A formatter of help messages for the current command line options

HelpFormatter() - Constructor for class org.apache.commons.cli.HelpFormatter

HelpFormatter.StringBufferComparator - class org.apache.commons.cli.HelpFormatter.StringBufferComparator.

HelpFormatter.StringBufferComparator() - Constructor for class org.apache.commons.cli.HelpFormatter.StringBufferComparator

hasArg - Variable in class org.apache.commons.cli.Option

hasArg specifies whether this option has an associated argument

hasArg() - Method in class org.apache.commons.cli.Option

Query to see if this Option requires an argument

hasArg() - Static method in class org.apache.commons.cli.OptionBuilder

The next Option created will require an argument value.

hasArg(boolean) - Static method in class org.apache.commons.cli.OptionBuilder

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

hasArgName() - Method in class org.apache.commons.cli.Option

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

hasArgs() - Method in class org.apache.commons.cli.Option

Query to see if this Option can take many values

hasArgs() - Static method in class org.apache.commons.cli.OptionBuilder

The next Option created can have unlimited argument values.

hasArgs(int) - Static method in class org.apache.commons.cli.OptionBuilder

The next Option created can have num argument values.

hasLongOpt() - Method in class org.apache.commons.cli.Option

Query to see if this Option has a long name

hasOption(String) - Method in class org.apache.commons.cli.CommandLine

Query to see if an option has been set.

hasOption(char) - Method in class org.apache.commons.cli.CommandLine

Query to see if an option has been set.

hasOption(String) - Method in class org.apache.commons.cli.Options

Returns whether the named Option is a member of this Options

hasOptionalArg() - Method in class org.apache.commons.cli.Option

hasOptionalArg() - Static method in class org.apache.commons.cli.OptionBuilder

The next Option can have an optional argument.

hasOptionalArgs() - Static method in class org.apache.commons.cli.OptionBuilder

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

hasOptionalArgs(int) - Static method in class org.apache.commons.cli.OptionBuilder

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

hashcodeMap - Variable in class org.apache.commons.cli.CommandLine

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

helpOptions() - Method in class org.apache.commons.cli.Options

Returns the Options for use by the HelpFormatter.

I

id - Variable in class org.apache.commons.cli.Option

option char (only valid for single character options)

init() - Method in class org.apache.commons.cli.GnuParser

Resets the members to their original state i.e.

init() - Method in class org.apache.commons.cli.PosixParser

Resets the members to their original state i.e.

instance - Static variable in class org.apache.commons.cli.OptionBuilder

option builder instance

isRequired() - Method in class org.apache.commons.cli.Option

Query to see if this Option requires an argument

isRequired() - Static method in class org.apache.commons.cli.OptionBuilder

The next Option created will be required.

isRequired(boolean) - Static method in class org.apache.commons.cli.OptionBuilder

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

isRequired() - Method in class org.apache.commons.cli.OptionGroup

Returns whether this option group is required.

isValidChar(char) - Method in class org.apache.commons.cli.Option

Returns whether the specified character is a valid character.

isValidOpt(char) - Method in class org.apache.commons.cli.Option

Returns whether the specified character is a valid Option.

isValueCode(char) - Static method in class org.apache.commons.cli.PatternOptionBuilder

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

iterator() - Method in class org.apache.commons.cli.CommandLine

Returns an iterator over the Option members of CommandLine.

L

longOpt - Variable in class org.apache.commons.cli.Option

longOpt is the long representation of the option

longOpts - Variable in class org.apache.commons.cli.Options

a map of the options with the long key

longopt - Static variable in class org.apache.commons.cli.OptionBuilder

long option

M

MissingArgumentException - exception org.apache.commons.cli.MissingArgumentException.

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

MissingArgumentException(String) - Constructor for class org.apache.commons.cli.MissingArgumentException

Construct a new MissingArgumentException with the specified detail message.

MissingOptionException - exception org.apache.commons.cli.MissingOptionException.

Thrown when a required option has not been provided.

MissingOptionException(String) - Constructor for class org.apache.commons.cli.MissingOptionException

Construct a new MissingSelectedException with the specified detail message.

N

NUMBER_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

Number class

numberOfArgs - Variable in class org.apache.commons.cli.Option

numberOfArgs specifies the number of argument values this option can have

numberOfArgs - Static variable in class org.apache.commons.cli.OptionBuilder

the number of arguments

O

OBJECT_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

Object class

Option - class org.apache.commons.cli.Option.

Describes a single command-line option.

Option(String, String) - Constructor for class org.apache.commons.cli.Option

Creates an Option using the specified parameters.

Option(String, boolean, String) - Constructor for class org.apache.commons.cli.Option

Creates an Option using the specified parameters.

Option(String, String, boolean, String) - Constructor for class org.apache.commons.cli.Option

Creates an Option using the specified parameters.

OptionBuilder - class org.apache.commons.cli.OptionBuilder.

OptionBuilder allows the user to create Options using descriptive methods.

OptionBuilder() - Constructor for class org.apache.commons.cli.OptionBuilder

OptionGroup - class org.apache.commons.cli.OptionGroup.

A group of mutually exclusive options.

OptionGroup() - Constructor for class org.apache.commons.cli.OptionGroup

Options - class org.apache.commons.cli.Options.

Main entry-point into the library.

Options() - Constructor for class org.apache.commons.cli.Options

Construct a new Options descriptor

opt - Variable in class org.apache.commons.cli.Option

opt the single character representation of the option

optionGroups - Variable in class org.apache.commons.cli.Options

a map of the option groups

optionMap - Variable in class org.apache.commons.cli.OptionGroup

hold the options

optionalArg - Variable in class org.apache.commons.cli.Option

specifies whether the argument value of this Option is optional

optionalArg - Static variable in class org.apache.commons.cli.OptionBuilder

option can have an optional argument value

options - Variable in class org.apache.commons.cli.CommandLine

the processed options

options - Variable in class org.apache.commons.cli.Parser

current Options

options - Variable in class org.apache.commons.cli.PosixParser

the command line Options

optionsArray - Variable in class org.apache.commons.cli.CommandLine

the processed options

org.apache.commons.cli - package org.apache.commons.cli

Commons CLI 1.0

P

ParseException - exception org.apache.commons.cli.ParseException.

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

ParseException(String) - Constructor for class org.apache.commons.cli.ParseException

Construct a new ParseException with the specified detail message.

Parser - class org.apache.commons.cli.Parser.

Parser creates CommandLines.

Parser() - Constructor for class org.apache.commons.cli.Parser

PatternOptionBuilder - class org.apache.commons.cli.PatternOptionBuilder.

Allows Options to be created from a single String.

PatternOptionBuilder() - Constructor for class org.apache.commons.cli.PatternOptionBuilder

PosixParser - class org.apache.commons.cli.PosixParser.

The class PosixParser provides an implementation of the flatten method.

PosixParser() - Constructor for class org.apache.commons.cli.PosixParser

parse(Options, String[]) - Method in interface org.apache.commons.cli.CommandLineParser

Parse the arguments according to the specified options.

parse(Options, String[], boolean) - Method in interface org.apache.commons.cli.CommandLineParser

Parse the arguments according to the specified options.

parse(Options, String[]) - Method in class org.apache.commons.cli.Parser

Parses the specified arguments based on the specifed Options.

parse(Options, String[], boolean) - Method in class org.apache.commons.cli.Parser

Parses the specified arguments based on the specifed Options.

parsePattern(String) - Static method in class org.apache.commons.cli.PatternOptionBuilder

Returns the Options instance represented by pattern.

printHelp(String, Options) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(String, Options, boolean) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(String, String, Options, String) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(String, String, Options, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(int, String, String, Options, String) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(int, String, String, Options, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(PrintWriter, int, String, String, Options, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter

printHelp(PrintWriter, int, String, String, Options, int, int, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter

printOptions(PrintWriter, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter

printUsage(PrintWriter, int, String, Options) - Method in class org.apache.commons.cli.HelpFormatter

Prints the usage statement for the specified application.

printUsage(PrintWriter, int, String) - Method in class org.apache.commons.cli.HelpFormatter

printWrapped(PrintWriter, int, String) - Method in class org.apache.commons.cli.HelpFormatter

printWrapped(PrintWriter, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter

process(String) - Method in class org.apache.commons.cli.PosixParser

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.

processArgs(Option, ListIterator) - Method in class org.apache.commons.cli.Parser

processOption(String, ListIterator) - Method in class org.apache.commons.cli.Parser

processOptionToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser

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

processSingleHyphen(String) - Method in class org.apache.commons.cli.PosixParser

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

R

renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter

renderWrappedText(StringBuffer, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter

required - Variable in class org.apache.commons.cli.Option

required specifies whether this option is required to be present

required - Static variable in class org.apache.commons.cli.OptionBuilder

is required?

required - Variable in class org.apache.commons.cli.OptionGroup

specified whether this group is required

requiredOptions - Variable in class org.apache.commons.cli.Parser

list of required options strings

requiredOpts - Variable in class org.apache.commons.cli.Options

a map of the required options

reset() - Static method in class org.apache.commons.cli.OptionBuilder

Resets the member variables to their default values.

rtrim(String) - Method in class org.apache.commons.cli.HelpFormatter

S

STRING_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

String class

selected - Variable in class org.apache.commons.cli.OptionGroup

the name of the selected option

setArgName(String) - Method in class org.apache.commons.cli.Option

Sets the display name for the argument value.

setArgs(int) - Method in class org.apache.commons.cli.Option

Sets the number of argument values this Option can take.

setLongOpt(String) - Method in class org.apache.commons.cli.Option

Sets the long name of this Option.

setOptionalArg(boolean) - Method in class org.apache.commons.cli.Option

Sets whether this Option can have an optional argument.

setRequired(boolean) - Method in class org.apache.commons.cli.Option

Sets whether this Option is mandatory.

setRequired(boolean) - Method in class org.apache.commons.cli.OptionGroup

setSelected(Option) - Method in class org.apache.commons.cli.OptionGroup

set the selected option of this group to name.

setType(Object) - Method in class org.apache.commons.cli.Option

Sets the type of this Option.

setValueSeparator(char) - Method in class org.apache.commons.cli.Option

Sets the value separator.

shortOpts - Variable in class org.apache.commons.cli.Options

a map of the options with the character key

stripPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter.StringBufferComparator

T

TypeHandler - class org.apache.commons.cli.TypeHandler.

This is a temporary implementation.

TypeHandler() - Constructor for class org.apache.commons.cli.TypeHandler

toString() - Method in class org.apache.commons.cli.Option

Dump state, suitable for debugging.

toString() - Method in class org.apache.commons.cli.OptionGroup

Returns the stringified version of this OptionGroup.

toString() - Method in class org.apache.commons.cli.Options

Dump state, suitable for debugging.

tokens - Variable in class org.apache.commons.cli.GnuParser

holder for flattened tokens

tokens - Variable in class org.apache.commons.cli.PosixParser

holder for flattened tokens

type - Variable in class org.apache.commons.cli.Option

the type of this Option

type - Static variable in class org.apache.commons.cli.OptionBuilder

option type

U

UNINITIALIZED - Static variable in class org.apache.commons.cli.Option

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

UNLIMITED_VALUES - Static variable in class org.apache.commons.cli.Option

constant that specifies the number of argument values is infinite

URL_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder

URL class

UnrecognizedOptionException - exception org.apache.commons.cli.UnrecognizedOptionException.

Exception thrown during parsing signalling an unrecognized option was seen.

UnrecognizedOptionException(String) - Constructor for class org.apache.commons.cli.UnrecognizedOptionException

Construct a new UnrecognizedArgumentException with the specified detail message.

V

validateOption(String) - Method in class org.apache.commons.cli.Option

Validates whether opt is a permissable Option shortOpt.

values - Variable in class org.apache.commons.cli.Option

the list of argument values

valuesep - Variable in class org.apache.commons.cli.Option

the character that is the value separator

valuesep - Static variable in class org.apache.commons.cli.OptionBuilder

value separator for argument value

W

withArgName(String) - Static method in class org.apache.commons.cli.OptionBuilder

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

withDescription(String) - Static method in class org.apache.commons.cli.OptionBuilder

The next Option created will have the specified description

withLongOpt(String) - Static method in class org.apache.commons.cli.OptionBuilder

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

withType(Object) - Static method in class org.apache.commons.cli.OptionBuilder

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

withValueSeparator(char) - Static method in class org.apache.commons.cli.OptionBuilder

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

withValueSeparator() - Static method in class org.apache.commons.cli.OptionBuilder

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

A B C D E F G H I L M N O P R S T U V W