- checkRequiredOptions() - Method in class org.apache.commons.cli.Parser
-
- CLASS_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
Class class
- clearValues() - Method in class org.apache.commons.cli.Option
-
Clear the Option values.
- 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.
- cmd - Variable in class org.apache.commons.cli.Parser
-
commandline instance
- CommandLine - Class in org.apache.commons.cli
-
Represents list of arguments parsed against
a
Options
descriptor.
- CommandLine() - Constructor for class org.apache.commons.cli.CommandLine
-
Creates a command line.
- CommandLineParser - Interface in org.apache.commons.cli
-
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.OptionComparator
-
Compares its two arguments for order.
- 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
.
- currentOption - Variable in class org.apache.commons.cli.PosixParser
-
holder for the current option
- 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.
- getKey() - Method in class org.apache.commons.cli.Option
-
Returns the 'unique' Option identifier.
- 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.
- getOption(String) - Method in class org.apache.commons.cli.Options
-
- getOptionGroup(Option) - Method in class org.apache.commons.cli.Options
-
Returns the OptionGroup the opt
belongs to.
- getOptionGroups() - Method in class org.apache.commons.cli.Options
-
Lists the OptionGroups that are members of this Options instance.
- 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
.
- getOptions() - Method in class org.apache.commons.cli.CommandLine
-
Returns an array of the processed
Option
s.
- 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(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.
- getOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
-
Returns the 'optPrefix'.
- 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.
- 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
- getValueSeparator() - Method in class org.apache.commons.cli.Option
-
Returns the value separator character.
- getValuesList() - Method in class org.apache.commons.cli.Option
-
- getWidth() - Method in class org.apache.commons.cli.HelpFormatter
-
Returns the 'width'.
- GnuParser - Class in org.apache.commons.cli
-
The class GnuParser provides an implementation of the
flatten
method.
- GnuParser() - Constructor for class org.apache.commons.cli.GnuParser
-
- gobble(Iterator) - Method in class org.apache.commons.cli.PosixParser
-
Adds the remaining tokens to the processed tokens list.
- 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.
- hashCode() - Method in class org.apache.commons.cli.Option
-
- hasLongOpt() - Method in class org.apache.commons.cli.Option
-
Query to see if this Option has a long name
- hasNoValues() - Method in class org.apache.commons.cli.Option
-
Returns whether this Option has any values.
- 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
-
- 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.
- HelpFormatter - Class in org.apache.commons.cli
-
A formatter of help messages for the current command line options
- HelpFormatter() - Constructor for class org.apache.commons.cli.HelpFormatter
-
- HelpFormatter.OptionComparator - Class in org.apache.commons.cli
-
This class implements the Comparator
interface
for comparing Options.
- helpOptions() - Method in class org.apache.commons.cli.Options
-
Returns the Options for use by the HelpFormatter.
- OBJECT_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
Object class
- opt - Variable in class org.apache.commons.cli.Option
-
opt the name of the option
- Option - Class in org.apache.commons.cli
-
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.
- 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
- OptionBuilder - Class in org.apache.commons.cli
-
OptionBuilder allows the user to create Options using descriptive
methods.
- OptionBuilder() - Constructor for class org.apache.commons.cli.OptionBuilder
-
private constructor to prevent instances being created
- OptionComparator() - Constructor for class org.apache.commons.cli.HelpFormatter.OptionComparator
-
- OptionGroup - Class in org.apache.commons.cli
-
A group of mutually exclusive options.
- OptionGroup() - Constructor for class org.apache.commons.cli.OptionGroup
-
- 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
- options - Variable in class org.apache.commons.cli.CommandLine
-
the processed options
- Options - Class in org.apache.commons.cli
-
Main entry-point into the library.
- Options() - Constructor for class org.apache.commons.cli.Options
-
Construct a new Options descriptor
- options - Variable in class org.apache.commons.cli.Parser
-
current Options
- options - Variable in class org.apache.commons.cli.PosixParser
-
the command line Options
- OptionValidator - Class in org.apache.commons.cli
-
Validates an Option string.
- OptionValidator() - Constructor for class org.apache.commons.cli.OptionValidator
-
- org.apache.commons.cli - package org.apache.commons.cli
-
Commons CLI 1.0
- 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.
- ParseException - Exception in org.apache.commons.cli
-
Base for Exceptions thrown during parsing of a command-line.
- ParseException(String) - Constructor for exception 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 in org.apache.commons.cli
-
- Parser() - Constructor for class org.apache.commons.cli.Parser
-
- PatternOptionBuilder - Class in org.apache.commons.cli
-
Allows Options to be created from a single String.
- PatternOptionBuilder() - Constructor for class org.apache.commons.cli.PatternOptionBuilder
-
- PosixParser - Class in org.apache.commons.cli
-
The class PosixParser provides an implementation of the
flatten
method.
- PosixParser() - Constructor for class org.apache.commons.cli.PosixParser
-
- 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.
- 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
-
Process the argument values for the specified Option
opt
using the values retrieved from the
specified iterator iter
.
- processOption(String, ListIterator) - Method in class org.apache.commons.cli.Parser
-
Process the Option specified by arg
using the values retrieved from the specfied iterator
iter
.
- 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.
- processProperties(Properties) - Method in class org.apache.commons.cli.Parser
-
Sets the values of Options using the values in
properties
.
- 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.
- processValue(String) - Method in class org.apache.commons.cli.Option
-
Processes the value.
- selected - Variable in class org.apache.commons.cli.OptionGroup
-
the name of the selected option
- 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'.
- setOptionalArg(boolean) - Method in class org.apache.commons.cli.Option
-
Sets whether this Option can have an optional argument.
- setOptPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
-
Sets the 'optPrefix'.
- 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'.
- shortOpts - Variable in class org.apache.commons.cli.Options
-
a map of the options with the character key
- STRING_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
String class
- stripLeadingAndTrailingQuotes(String) - Static method in class org.apache.commons.cli.Util
-
Remove the leading and trailing quotes from str
.
- stripLeadingHyphens(String) - Static method in class org.apache.commons.cli.Util
-
Remove the hyphens from the begining of str
and
return the new String.