A B C D E F G H I M N O P R S T U 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.
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
Deprecated.  

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.
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.
clone() - Method in class org.apache.commons.cli.Option
A rather odd clone method - due to incorrect code in 1.0 it is public and in 1.1 rather than throwing a CloneNotSupportedException it throws a RuntimeException so as to maintain backwards compat at the API level.
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
Return a String of padding of length len.
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.

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 name for an argument
DEFAULT_DESC_PAD - Static variable in class org.apache.commons.cli.HelpFormatter
the number of characters of padding to be prefixed to each description line
DEFAULT_LEFT_PAD - Static variable in class org.apache.commons.cli.HelpFormatter
default padding to the left of each line
DEFAULT_LONG_OPT_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter
default prefix for long Option
DEFAULT_OPT_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter
default prefix for shortOpts
DEFAULT_SYNTAX_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter
the string to display at the begining of the usage statement
DEFAULT_WIDTH - Static variable in class org.apache.commons.cli.HelpFormatter
default number of characters per line
defaultArgName - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setArgName methods instead.
defaultDescPad - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setDescPadding methods instead.
defaultLeftPad - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setLeftPadding methods instead.
defaultLongOptPrefix - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setLongOptPrefix methods instead.
defaultNewLine - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setNewLine methods instead.
defaultOptPrefix - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setOptPrefix methods instead.
defaultSyntaxPrefix - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setSyntaxPrefix methods instead.
defaultWidth - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated. Scope will be made private for next major version - use get/setWidth methods instead.

E

EXISTING_FILE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
FileInputStream class
equals(Object) - Method in class org.apache.commons.cli.Option
 

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 text 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.HelpFormatter
Returns the 'argName'.
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.
getDescPadding() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'descPadding'.
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.
getLeftPadding() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'leftPadding'.
getLongOpt() - Method in class org.apache.commons.cli.Option
Retrieve the long name of this Option.
getLongOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'longOptPrefix'.
getNames() - Method in class org.apache.commons.cli.OptionGroup
 
getNewLine() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'newLine'.
getOpt() - Method in class org.apache.commons.cli.Option
Retrieve the name of this Option.
getOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'optPrefix'.
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
 
getSyntaxPrefix() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'syntaxPrefix'.
getType() - Method in class org.apache.commons.cli.Option
Retrieve the type of this Option.
getValue() - Method in class org.apache.commons.cli.Option
Returns the specified value of this Option or null if there is no value.
getValue(int) - Method in class org.apache.commons.cli.Option
Returns the specified value of this Option or null if there is no value.
getValue(String) - Method in class org.apache.commons.cli.Option
Returns the value/first value of this Option or the defaultValue if there is no value.
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
Return the values of this Option as a String array or null if there are no values
getValuesList() - Method in class org.apache.commons.cli.Option
 
getWidth() - Method in class org.apache.commons.cli.HelpFormatter
Returns the 'width'.

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
 
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.
hasValueSeparator() - Method in class org.apache.commons.cli.Option
Return whether this Option has specified a value separator.
hashCode() - Method in class org.apache.commons.cli.Option
 

I

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

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

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.
OptionGroup - class org.apache.commons.cli.OptionGroup.
A group of mutually exclusive options.
OptionGroup() - Constructor for class org.apache.commons.cli.OptionGroup
 
OptionValidator - class org.apache.commons.cli.OptionValidator.
Validates an Option string.
OptionValidator() - Constructor for class org.apache.commons.cli.OptionValidator
 
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
org.apache.commons.cli - package org.apache.commons.cli
Commons CLI 1.1

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[], Properties) - Method in class org.apache.commons.cli.Parser
Parse the arguments according to the specified options and properties.
parse(Options, String[], boolean) - Method in class org.apache.commons.cli.Parser
Parses the specified arguments based on the specifed Options.
parse(Options, String[], Properties, boolean) - Method in class org.apache.commons.cli.Parser
Parse the arguments according to the specified options and properties.
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
Print the help for options with the specified command line syntax.
printHelp(String, Options, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printHelp(String, String, Options, String) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printHelp(String, String, Options, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printHelp(int, String, String, Options, String) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printHelp(int, String, String, Options, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printHelp(PrintWriter, int, String, String, Options, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printHelp(PrintWriter, int, String, String, Options, int, int, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for options with the specified command line syntax.
printOptions(PrintWriter, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter
Print the help for the specified Options to the specified writer, using the specified width, left padding and description padding.
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
Print the cmdLineSyntax to the specified writer, using the specified width.
printWrapped(PrintWriter, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Print the specified text to the specified PrintWriter.
printWrapped(PrintWriter, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Print the specified text to the specified PrintWriter.
processArgs(Option, ListIterator) - Method in class org.apache.commons.cli.Parser
Process the argument values for the specified Option opt using the values retrieved from the specified iterator iter.

R

renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter
Render the specified Options and return the rendered Options in a StringBuffer.
renderWrappedText(StringBuffer, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Render the specified text and return the rendered Options in a StringBuffer.
rtrim(String) - Method in class org.apache.commons.cli.HelpFormatter
Remove the trailing whitespace from the specified String.

S

STRING_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
String class
setArgName(String) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'argName'.
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.
setDescPadding(int) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'descPadding'.
setDescription(String) - Method in class org.apache.commons.cli.Option
Sets the self-documenting description of this Option
setLeftPadding(int) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'leftPadding'.
setLongOpt(String) - Method in class org.apache.commons.cli.Option
Sets the long name of this Option.
setLongOptPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'longOptPrefix'.
setNewLine(String) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'newLine'.
setOptPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'optPrefix'.
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.
setSyntaxPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'syntaxPrefix'.
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.
setWidth(int) - Method in class org.apache.commons.cli.HelpFormatter
Sets the 'width'.

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.

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.

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 M N O P R S T U W

Copyright © 2002-2007 Apache Software Foundation. All Rights Reserved.