Alphabetical Index

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

A

addArg(String) - method in class org.apache.commons.cli.CommandLine
Add left-over unrecognized option/argument.
addOption(org.apache.commons.cli.Option) - method in class org.apache.commons.cli.CommandLine
Add an option to the command line.
addOption(org.apache.commons.cli.Option) - method in class org.apache.commons.cli.OptionGroup
add opt to this group
addOption(org.apache.commons.cli.Option) - method in class org.apache.commons.cli.Options
Adds an option instance
addOption(String,boolean,String) - method in class org.apache.commons.cli.Options
Add an option that only contains a short-name

It may be specified as requiring an argument.

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

It may be specified as requiring an argument.

addOptionGroup(org.apache.commons.cli.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.
AlreadySelectedException - class 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.
argName - field in class org.apache.commons.cli.Option
argName specifies the name of the argument for this option
argName - static field in class org.apache.commons.cli.OptionBuilder
argument name
args - field 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.
burstToken(String,boolean) - method in class org.apache.commons.cli.PosixParser
Breaks token into its constituent parts using the following algorithm.

C

checkRequiredOptions() - method in class org.apache.commons.cli.Parser
Throws a MissingOptionException if all of the required options are no present.
CLASS_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
Class class
clone() - method in class org.apache.commons.cli.Option
cmd - field in class org.apache.commons.cli.Parser
commandline instance
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.
compare(Object,Object) - method in class org.apache.commons.cli.HelpFormatter.StringBufferComparator
create() - static method in class org.apache.commons.cli.OptionBuilder
Create an Option using the current settings
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(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,Class) - static method in class org.apache.commons.cli.TypeHandler
Returns the Object of type clazz with the value of str.
createValue(String,Object) - static method in class org.apache.commons.cli.TypeHandler
Returns the Object of type obj with the value of str.
currentOption - field in class org.apache.commons.cli.PosixParser
holder for the current option

D

DATE_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
Date class
DEFAULT_ARG_NAME - static field in class org.apache.commons.cli.HelpFormatter
DEFAULT_DESC_PAD - static field in class org.apache.commons.cli.HelpFormatter
DEFAULT_LEFT_PAD - static field in class org.apache.commons.cli.HelpFormatter
DEFAULT_LONG_OPT_PREFIX - static field in class org.apache.commons.cli.HelpFormatter
DEFAULT_OPT_PREFIX - static field in class org.apache.commons.cli.HelpFormatter
DEFAULT_SYNTAX_PREFIX - static field in class org.apache.commons.cli.HelpFormatter
DEFAULT_WIDTH - static field in class org.apache.commons.cli.HelpFormatter
defaultArgName - field in class org.apache.commons.cli.HelpFormatter
defaultDescPad - field in class org.apache.commons.cli.HelpFormatter
defaultLeftPad - field in class org.apache.commons.cli.HelpFormatter
defaultLongOptPrefix - field in class org.apache.commons.cli.HelpFormatter
defaultNewLine - field in class org.apache.commons.cli.HelpFormatter
defaultOptPrefix - field in class org.apache.commons.cli.HelpFormatter
defaultSyntaxPrefix - field in class org.apache.commons.cli.HelpFormatter
defaultWidth - field in class org.apache.commons.cli.HelpFormatter
description - field in class org.apache.commons.cli.Option
description of the option
description - static field in class org.apache.commons.cli.OptionBuilder
option description

E

eatTheRest - field in class org.apache.commons.cli.PosixParser
specifies if bursting should continue
EXISTING_FILE_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
FileInputStream class

F

FILE_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
File class
FILES_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
File array 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.
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.
flatten(org.apache.commons.cli.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.
An implementation of Parser's abstract flatten method.

G

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(org.apache.commons.cli.Option) - method in class org.apache.commons.cli.Options
Returns the OptionGroup the opt belongs to.
getOptionObject(char) - method in class org.apache.commons.cli.CommandLine
Return the Object type of this Option.
getOptionObject(String) - method in class org.apache.commons.cli.CommandLine
Return the Object type of this 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
getOptionValue(char) - method in class org.apache.commons.cli.CommandLine
Retrieve the argument, if any, of this option.
getOptionValue(char,String) - method in class org.apache.commons.cli.CommandLine
Retrieve the argument, if any, of an option.
getOptionValue(String) - 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.
getOptionValues(char) - method in class org.apache.commons.cli.CommandLine
Retrieves the array of values, 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.
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.
getValues() - method in class org.apache.commons.cli.Option
getValueSeparator() - method in class org.apache.commons.cli.Option
Returns the value separator character.
getValuesList() - method in class org.apache.commons.cli.Option
GnuParser - class org.apache.commons.cli.GnuParser
The class GnuParser provides an implementation of the flatten method.
gobble(Iterator) - method in class org.apache.commons.cli.PosixParser
Adds the remaining tokens to the processed tokens list.

H

hasArg - field 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.
hashcodeMap - field in class org.apache.commons.cli.CommandLine
Map of unique options for ease to get complete list of options
hasLongOpt() - method in class org.apache.commons.cli.Option
Query to see if this Option has a long name
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.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.
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
helpOptions() - method in class org.apache.commons.cli.Options
Returns the Options for use by the HelpFormatter.

I

id - field 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 field 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() - method in class org.apache.commons.cli.OptionGroup
Returns whether this option group is required.
isRequired(boolean) - static method in class org.apache.commons.cli.OptionBuilder
The next Option created will be required if required is true.
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 - field in class org.apache.commons.cli.Option
longOpt is the long representation of the option
longopt - static field in class org.apache.commons.cli.OptionBuilder
long option
longOpts - field in class org.apache.commons.cli.Options
a map of the options with the long key

M

MissingArgumentException - class 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 - class 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 field in class org.apache.commons.cli.PatternOptionBuilder
Number class
numberOfArgs - field in class org.apache.commons.cli.Option
numberOfArgs specifies the number of argument values this option can have
numberOfArgs - static field in class org.apache.commons.cli.OptionBuilder
the number of arguments

O

OBJECT_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
Object class
opt - field in class org.apache.commons.cli.Option
opt the single character representation of the option
Option - class org.apache.commons.cli.Option
Describes a single command-line option.
Option(String,boolean,String) - constructor for class org.apache.commons.cli.Option
Creates an Option using the specified parameters.
Option(String,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.
optionalArg - field in class org.apache.commons.cli.Option
specifies whether the argument value of this Option is optional
optionalArg - static field in class org.apache.commons.cli.OptionBuilder
option can have an optional argument value
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.
optionGroups - field in class org.apache.commons.cli.Options
a map of the option groups
optionMap - field in class org.apache.commons.cli.OptionGroup
hold the options
options - field in class org.apache.commons.cli.CommandLine
the processed options
Options - class org.apache.commons.cli.Options
Main entry-point into the library.
options - field in class org.apache.commons.cli.Parser
current Options
options - field in class org.apache.commons.cli.PosixParser
the command line Options
Options() - constructor for class org.apache.commons.cli.Options
Construct a new Options descriptor
optionsArray - field in class org.apache.commons.cli.CommandLine
the processed options
Commons CLI 1.0

P

parse(org.apache.commons.cli.Options,String[]) - method in class org.apache.commons.cli.CommandLineParser
Parse the arguments according to the specified options.
parse(org.apache.commons.cli.Options,String[]) - method in class org.apache.commons.cli.Parser
Parses the specified arguments based on the specifed Options.
Parse the arguments according to the specified options.
parse(org.apache.commons.cli.Options,String[],boolean) - method in class org.apache.commons.cli.Parser
Parses the specified arguments based on the specifed Options.
ParseException - class 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.
parsePattern(String) - static method in class org.apache.commons.cli.PatternOptionBuilder
Returns the Options instance represented by pattern.
Parser - class org.apache.commons.cli.Parser
Parser creates CommandLines.
PatternOptionBuilder - class org.apache.commons.cli.PatternOptionBuilder
Allows Options to be created from a single String.
PosixParser - class org.apache.commons.cli.PosixParser
The class PosixParser provides an implementation of the flatten method.
printHelp(String,org.apache.commons.cli.Options) - method in class org.apache.commons.cli.HelpFormatter
printUsage(PrintWriter,int,String) - method in class org.apache.commons.cli.HelpFormatter
Prints the usage statement for the specified application.
printWrapped(PrintWriter,int,int,String) - method in class org.apache.commons.cli.HelpFormatter
printWrapped(PrintWriter,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(org.apache.commons.cli.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

renderWrappedText(StringBuffer,int,int,String) - method in class org.apache.commons.cli.HelpFormatter
required - field in class org.apache.commons.cli.Option
required specifies whether this option is required to be present
required - static field in class org.apache.commons.cli.OptionBuilder
is required?
required - field in class org.apache.commons.cli.OptionGroup
specified whether this group is required
requiredOptions - field in class org.apache.commons.cli.Parser
list of required options strings
requiredOpts - field 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

selected - field 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(org.apache.commons.cli.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 - field in class org.apache.commons.cli.Options
a map of the options with the character key
STRING_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
String class
stripPrefix(String) - method in class org.apache.commons.cli.HelpFormatter.StringBufferComparator

T

tokens - field in class org.apache.commons.cli.GnuParser
holder for flattened tokens
tokens - field in class org.apache.commons.cli.PosixParser
holder for flattened tokens
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.
type - field in class org.apache.commons.cli.Option
the type of this Option
type - static field in class org.apache.commons.cli.OptionBuilder
option type
TypeHandler - class org.apache.commons.cli.TypeHandler
This is a temporary implementation.

U

UNINITIALIZED - static field in class org.apache.commons.cli.Option
constant that specifies the number of argument values has not been specified
UNLIMITED_VALUES - static field in class org.apache.commons.cli.Option
constant that specifies the number of argument values is infinite
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.
URL_VALUE - static field in class org.apache.commons.cli.PatternOptionBuilder
URL class

V

validateOption(String) - method in class org.apache.commons.cli.Option
Validates whether opt is a permissable Option shortOpt.
values - field in class org.apache.commons.cli.Option
the list of argument values *
valuesep - field in class org.apache.commons.cli.Option
the character that is the value separator
valuesep - static field 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() - static method in class org.apache.commons.cli.OptionBuilder
The next Option created uses '=' as a means to separate argument values.
withValueSeparator(char) - static method in class org.apache.commons.cli.OptionBuilder
The next Option created uses sep as a means to separate argument values.