A B C D E F G H I L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- acceptsArg() - Method in class org.apache.commons.cli.Option
-
Tells if the option can accept more arguments.
- add(String) - Method in class org.apache.commons.cli.Option
-
Add the value to this Option.
- addArg(String) - Method in class org.apache.commons.cli.CommandLine
-
Add left-over unrecognized option/argument.
- addArg(String) - Method in class org.apache.commons.cli.CommandLine.Builder
-
Add left-over unrecognized option/argument.
- addOption(String, boolean, String) - Method in class org.apache.commons.cli.Options
-
Add an option that only contains a short-name.
- addOption(String, 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.CommandLine
-
Add an option to the command line.
- addOption(Option) - Method in class org.apache.commons.cli.CommandLine.Builder
-
Add an option to the command line.
- addOption(Option) - Method in class org.apache.commons.cli.OptionGroup
-
Add the specified
Option
to this group. - 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.
- addRequiredOption(String, String, boolean, String) - Method in class org.apache.commons.cli.Options
-
Add an option that contains a short-name and a long-name.
- addValue(String) - Method in class org.apache.commons.cli.Option
-
Deprecated.
- addValueForProcessing(String) - Method in class org.apache.commons.cli.Option
-
Adds the specified value to this Option.
- AlreadySelectedException - Exception in org.apache.commons.cli
-
Thrown when more than one option in an option group has been provided.
- AlreadySelectedException(String) - Constructor for exception org.apache.commons.cli.AlreadySelectedException
-
Construct a new
AlreadySelectedException
with the specified detail message. - AlreadySelectedException(OptionGroup, Option) - Constructor for exception org.apache.commons.cli.AlreadySelectedException
-
Construct a new
AlreadySelectedException
for the specified option group. - AmbiguousOptionException - Exception in org.apache.commons.cli
-
Exception thrown when an option can't be identified from a partial name.
- AmbiguousOptionException(String, Collection<String>) - Constructor for exception org.apache.commons.cli.AmbiguousOptionException
-
Constructs a new AmbiguousOptionException.
- appendOption(StringBuffer, Option, boolean) - Method in class org.apache.commons.cli.HelpFormatter
-
Appends the usage clause for an Option to a StringBuffer.
- appendOptionGroup(StringBuffer, OptionGroup) - Method in class org.apache.commons.cli.HelpFormatter
-
Appends the usage clause for an OptionGroup to a StringBuffer.
- argName - Variable in class org.apache.commons.cli.Option
-
the name of the argument for this option
- argName - Variable in class org.apache.commons.cli.Option.Builder
-
the name of the argument for this option
- argName - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.argument name
- argName(String) - Method in class org.apache.commons.cli.Option.Builder
-
Sets the display name for the argument value.
- args - Variable in class org.apache.commons.cli.CommandLine
-
the unrecognized options/arguments
B
- BasicParser - Class in org.apache.commons.cli
-
Deprecated.since 1.3, use the
DefaultParser
instead - BasicParser() - Constructor for class org.apache.commons.cli.BasicParser
-
Deprecated.
- build() - Method in class org.apache.commons.cli.CommandLine.Builder
- build() - Method in class org.apache.commons.cli.Option.Builder
-
Constructs an Option with the values declared by this
Option.Builder
. - builder() - Static method in class org.apache.commons.cli.Option
-
Returns a
Option.Builder
to create anOption
using descriptive methods. - builder(String) - Static method in class org.apache.commons.cli.Option
-
Returns a
Option.Builder
to create anOption
using descriptive methods. - Builder() - Constructor for class org.apache.commons.cli.CommandLine.Builder
- Builder(String) - Constructor for class org.apache.commons.cli.Option.Builder
-
Constructs a new
Builder
with the minimum required parameters for anOption
instance. - burstToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser
-
Deprecated.Breaks
token
into its constituent parts using the following algorithm.
C
- checkRequiredArgs() - Method in class org.apache.commons.cli.DefaultParser
-
Throw a
MissingArgumentException
if the current option didn't receive the number of arguments expected. - checkRequiredOptions() - Method in class org.apache.commons.cli.DefaultParser
-
Throws a
MissingOptionException
if all of the required options are not present. - checkRequiredOptions() - Method in class org.apache.commons.cli.Parser
-
Deprecated.Throws a
MissingOptionException
if all of the required options are not present. - 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.DefaultParser
-
The command-line instance.
- cmd - Variable in class org.apache.commons.cli.Parser
-
Deprecated.commandline instance
- commandLine - Variable in class org.apache.commons.cli.CommandLine.Builder
-
CommandLine that is being build by this Builder.
- 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.
- CommandLine.Builder - Class in org.apache.commons.cli
-
A nested builder class to create
CommandLine
instance using descriptive methods. - CommandLineParser - Interface in org.apache.commons.cli
-
A class that implements the
CommandLineParser
interface can parse a String array according to theOptions
specified and return aCommandLine
. - compare(Option, Option) - Method in class org.apache.commons.cli.HelpFormatter.OptionComparator
-
Compares its two arguments for order.
- create() - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.Create an Option using the current settings
- create(char) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.Create an Option using the current settings and with the specified Option
char
. - create(String) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.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
classname
. - 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
. - createMessage(String, Collection<String>) - Static method in exception org.apache.commons.cli.AmbiguousOptionException
-
Build the exception message from the specified list of options.
- createMessage(List<?>) - Static method in exception org.apache.commons.cli.MissingOptionException
-
Build the exception message from the specified list of options.
- 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, Class<?>) - Static method in class org.apache.commons.cli.TypeHandler
-
Returns the
Object
of typeclazz
with the value ofstr
. - createValue(String, Object) - Static method in class org.apache.commons.cli.TypeHandler
-
Returns the
Object
of typeobj
with the value ofstr
. - currentOption - Variable in class org.apache.commons.cli.DefaultParser
-
The last option parsed.
- currentOption - Variable in class org.apache.commons.cli.PosixParser
-
Deprecated.holder for the current option
- currentToken - Variable in class org.apache.commons.cli.DefaultParser
-
The token currently processed.
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
-
number of space characters 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_LONG_OPT_SEPARATOR - Static variable in class org.apache.commons.cli.HelpFormatter
-
default separator displayed between a long Option and its value
- 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 beginning 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.
- DefaultParser - Class in org.apache.commons.cli
-
Default parser.
- DefaultParser() - Constructor for class org.apache.commons.cli.DefaultParser
- 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.
- desc(String) - Method in class org.apache.commons.cli.Option.Builder
-
Sets the description for this option.
- description - Variable in class org.apache.commons.cli.Option.Builder
-
description of the option
- description - Variable in class org.apache.commons.cli.Option
-
description of the option
- description - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.option description
E
- eatTheRest - Variable in class org.apache.commons.cli.PosixParser
-
Deprecated.specifies if bursting should continue
- equals(Object) - Method in class org.apache.commons.cli.Option
- EXISTING_FILE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
FileInputStream class
- expectedOpts - Variable in class org.apache.commons.cli.DefaultParser
-
The required options and groups expected to be found when parsing the command line.
F
- FILE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
File class
- FILES_VALUE - Static variable 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 intext
with the column widthwidth
. - flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.BasicParser
-
Deprecated.
- flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.GnuParser
-
Deprecated.
- flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.Parser
-
Deprecated.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
-
Deprecated.
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.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.
- getLongOption(String) - Method in class org.apache.commons.cli.Options
-
Retrieve the
Option
matching the long name specified. - getLongOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
-
Returns the 'longOptPrefix'.
- getLongOptSeparator() - Method in class org.apache.commons.cli.HelpFormatter
-
Returns the separator displayed between a long option and its value.
- getLongPrefix(String) - Method in class org.apache.commons.cli.DefaultParser
-
Search for a prefix that is the long name of an option (-Xmx512m)
- getMatchingOptions() - Method in exception org.apache.commons.cli.AmbiguousOptionException
-
Returns the options matching the partial name.
- getMatchingOptions(String) - Method in class org.apache.commons.cli.Options
-
Returns the options with a long name starting with the name specified.
- getMissingOptions() - Method in exception org.apache.commons.cli.MissingOptionException
-
Returns the list of options or option groups missing in the command line parsed.
- 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() - Method in exception org.apache.commons.cli.AlreadySelectedException
-
Returns the option that was added to the group and triggered the exception.
- getOption() - Method in exception org.apache.commons.cli.MissingArgumentException
-
Return the option requiring an argument that wasn't provided on the command line.
- getOption() - Method in exception org.apache.commons.cli.UnrecognizedOptionException
-
Returns the unrecognized option.
- getOption(String) - Method in class org.apache.commons.cli.Options
-
Retrieve the
Option
matching the long or short name specified. - getOptionComparator() - Method in class org.apache.commons.cli.HelpFormatter
-
Comparator used to sort the options when they output in help text.
- getOptionGroup() - Method in exception org.apache.commons.cli.AlreadySelectedException
-
Returns the option group where another option has been selected.
- 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(char) - Method in class org.apache.commons.cli.CommandLine
-
Return the
Object
type of thisOption
. - getOptionObject(String) - Method in class org.apache.commons.cli.CommandLine
-
Deprecated.due to System.err message. Instead use getParsedOptionValue(String)
- getOptionProperties(String) - Method in class org.apache.commons.cli.CommandLine
-
Retrieve the map of values associated to the 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
- getOptions() - Method in class org.apache.commons.cli.Parser
-
Deprecated.
- getOptionValue(char) - Method in class org.apache.commons.cli.CommandLine
-
Retrieve the first 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 first argument, if any, of this option.
- getOptionValue(String, String) - Method in class org.apache.commons.cli.CommandLine
-
Retrieve the first 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.
- getOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
-
Returns the 'optPrefix'.
- getParsedOptionValue(String) - Method in class org.apache.commons.cli.CommandLine
-
Return a version of this
Option
converted to a particular type. - getRequiredOptions() - Method in class org.apache.commons.cli.Options
-
Returns the required options.
- getRequiredOptions() - Method in class org.apache.commons.cli.Parser
-
Deprecated.
- 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
-
Deprecated.since 1.3, use the
DefaultParser
instead - GnuParser() - Constructor for class org.apache.commons.cli.GnuParser
-
Deprecated.
- gobble(Iterator<String>) - Method in class org.apache.commons.cli.PosixParser
-
Deprecated.Adds the remaining tokens to the processed tokens list.
- group - Variable in exception org.apache.commons.cli.AlreadySelectedException
-
The option group selected.
H
- handleConcatenatedOptions(String) - Method in class org.apache.commons.cli.DefaultParser
-
Breaks
token
into its constituent parts using the following algorithm. - handleLongOption(String) - Method in class org.apache.commons.cli.DefaultParser
-
Handles the following tokens: --L --L=V --L V --l
- handleLongOptionWithEqual(String) - Method in class org.apache.commons.cli.DefaultParser
-
Handles the following tokens: --L=V -L=V --l=V -l=V
- handleLongOptionWithoutEqual(String) - Method in class org.apache.commons.cli.DefaultParser
-
Handles the following tokens: --L -L --l -l
- handleOption(Option) - Method in class org.apache.commons.cli.DefaultParser
- handleProperties(Properties) - Method in class org.apache.commons.cli.DefaultParser
-
Sets the values of Options using the values in
properties
. - handleShortAndLongOption(String) - Method in class org.apache.commons.cli.DefaultParser
-
Handles the following tokens: -S -SV -S V -S=V -S1S2 -S1S2 V -SV1=V2 -L -LV -L V -L=V -l
- handleToken(String) - Method in class org.apache.commons.cli.DefaultParser
-
Handle any command line token.
- handleUnknownToken(String) - Method in class org.apache.commons.cli.DefaultParser
-
Handles an unknown token.
- hasArg() - Method in class org.apache.commons.cli.Option.Builder
-
Indicates that the Option will require an 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
-
Deprecated.The next Option created will require an argument value.
- hasArg(boolean) - Method in class org.apache.commons.cli.Option.Builder
-
Indicates if the Option has an argument or not.
- hasArg(boolean) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.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.Builder
-
Indicates that the Option can have unlimited argument values.
- 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
-
Deprecated.The next Option created can have unlimited argument values.
- hasArgs(int) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.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
- hasLongOption(String) - Method in class org.apache.commons.cli.Options
- hasNoValues() - Method in class org.apache.commons.cli.Option
-
Returns whether this Option has any values.
- 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
- hasOptionalArg() - Method in class org.apache.commons.cli.Option
- hasOptionalArg() - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option can have an optional argument.
- hasOptionalArgs() - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option can have an unlimited number of optional arguments.
- hasOptionalArgs(int) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option can have the specified number of optional arguments.
- hasShortOption(String) - Method in class org.apache.commons.cli.Options
- 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 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.
I
- init() - Method in class org.apache.commons.cli.PosixParser
-
Deprecated.Resets the members to their original state i.e.
- INSTANCE - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.option builder instance
- isArgument(String) - Method in class org.apache.commons.cli.DefaultParser
-
Returns true is the token is a valid argument.
- isJavaProperty(String) - Method in class org.apache.commons.cli.DefaultParser
-
Check if the specified token is a Java-like property (-Dkey=value).
- isLongOption(String) - Method in class org.apache.commons.cli.DefaultParser
-
Tells if the token looks like a long option.
- isNegativeNumber(String) - Method in class org.apache.commons.cli.DefaultParser
-
Check if the token is a negative number.
- isOption(String) - Method in class org.apache.commons.cli.DefaultParser
-
Tells if the token looks like an option.
- isRequired() - Method in class org.apache.commons.cli.Option
-
Query to see if this Option is mandatory
- isRequired() - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.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
-
Deprecated.The next Option created will be required if
required
is true. - isShortOption(String) - Method in class org.apache.commons.cli.DefaultParser
-
Tells if the token looks like a short option.
- isValidChar(char) - Static method in class org.apache.commons.cli.OptionValidator
-
Returns whether the specified character is a valid character.
- isValidOpt(char) - Static method in class org.apache.commons.cli.OptionValidator
-
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 - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.long option
- longOpt - Variable in class org.apache.commons.cli.Option.Builder
-
the long representation of the option
- longOpt - Variable in class org.apache.commons.cli.Option
-
the long representation of the option
- longOpt(String) - Method in class org.apache.commons.cli.Option.Builder
-
Sets the long name of the Option.
- longOpts - Variable in class org.apache.commons.cli.Options
-
a map of the options with the long key
- longOptSeparator - Variable in class org.apache.commons.cli.HelpFormatter
-
The separator displayed between the long option and its value.
M
- matchingOptions - Variable in exception org.apache.commons.cli.AmbiguousOptionException
-
The list of options matching the partial name specified
- MissingArgumentException - Exception in org.apache.commons.cli
-
Thrown when an option requiring an argument is not provided with an argument.
- MissingArgumentException(String) - Constructor for exception org.apache.commons.cli.MissingArgumentException
-
Construct a new
MissingArgumentException
with the specified detail message. - MissingArgumentException(Option) - Constructor for exception org.apache.commons.cli.MissingArgumentException
-
Construct a new
MissingArgumentException
with the specified detail message. - MissingOptionException - Exception in org.apache.commons.cli
-
Thrown when a required option has not been provided.
- MissingOptionException(String) - Constructor for exception org.apache.commons.cli.MissingOptionException
-
Construct a new
MissingSelectedException
with the specified detail message. - MissingOptionException(List) - Constructor for exception org.apache.commons.cli.MissingOptionException
-
Constructs a new
MissingSelectedException
with the specified list of missing options. - missingOptions - Variable in exception org.apache.commons.cli.MissingOptionException
-
The list of missing options and groups
N
- NUMBER_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
Number class
- numberOfArgs - Variable in class org.apache.commons.cli.Option.Builder
-
the number of argument values this option can have
- numberOfArgs - Variable in class org.apache.commons.cli.Option
-
the number of argument values this option can have
- numberOfArgs - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.the number of arguments
- numberOfArgs(int) - Method in class org.apache.commons.cli.Option.Builder
-
Sets the number of argument values the Option can take.
O
- OBJECT_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
Object class
- opt - Variable in class org.apache.commons.cli.Option.Builder
-
the name of the option
- opt - Variable in class org.apache.commons.cli.Option
-
the name of the option
- option - Variable in exception org.apache.commons.cli.AlreadySelectedException
-
The option that triggered the exception.
- option - Variable in exception org.apache.commons.cli.MissingArgumentException
-
The option requiring additional arguments
- option - Variable in exception org.apache.commons.cli.UnrecognizedOptionException
-
The unrecognized option
- Option - Class in org.apache.commons.cli
-
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.
- Option(Option.Builder) - Constructor for class org.apache.commons.cli.Option
-
Private constructor used by the nested Builder class.
- Option.Builder - Class in org.apache.commons.cli
-
A nested builder class to create
Option
instances using descriptive methods. - optionalArg - Variable in class org.apache.commons.cli.Option.Builder
-
specifies whether the argument value of this Option is optional
- 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
-
Deprecated.option can have an optional argument value
- optionalArg(boolean) - Method in class org.apache.commons.cli.Option.Builder
-
Sets whether the Option can have an optional argument.
- OptionBuilder - Class in org.apache.commons.cli
-
Deprecated.since 1.3, use
Option.builder(String)
instead - OptionBuilder() - Constructor for class org.apache.commons.cli.OptionBuilder
-
Deprecated.private constructor to prevent instances being created
- optionComparator - Variable in class org.apache.commons.cli.HelpFormatter
-
Comparator used to sort the options when they output in help text Defaults to case-insensitive alphabetical sorting by option key
- 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 - Variable in class org.apache.commons.cli.DefaultParser
-
The current options.
- options - Variable in class org.apache.commons.cli.Parser
-
Deprecated.current Options
- options - Variable in class org.apache.commons.cli.PosixParser
-
Deprecated.the command line Options
- Options - Class in org.apache.commons.cli
-
Main entry-point into the library.
- Options() - Constructor for class org.apache.commons.cli.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.3
P
- parse(Options, String[]) - 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.DefaultParser
- parse(Options, String[]) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Parses the specified
arguments
based on the specifiedOptions
. - parse(Options, String[], boolean) - Method in interface org.apache.commons.cli.CommandLineParser
-
Parse the arguments according to the specified options.
- parse(Options, String[], boolean) - Method in class org.apache.commons.cli.DefaultParser
- parse(Options, String[], boolean) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Parses the specified
arguments
based on the specifiedOptions
. - parse(Options, String[], Properties) - Method in class org.apache.commons.cli.DefaultParser
-
Parse the arguments according to the specified options and properties.
- parse(Options, String[], Properties) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Parse the arguments according to the specified options and properties.
- parse(Options, String[], Properties, boolean) - Method in class org.apache.commons.cli.DefaultParser
-
Parse the arguments according to the specified options and properties.
- parse(Options, String[], Properties, boolean) - Method in class org.apache.commons.cli.Parser
-
Deprecated.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 bypattern
. - Parser - Class in org.apache.commons.cli
-
Deprecated.since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases
- Parser() - Constructor for class org.apache.commons.cli.Parser
-
Deprecated.
- 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
-
Deprecated.since 1.3, use the
DefaultParser
instead - PosixParser() - Constructor for class org.apache.commons.cli.PosixParser
-
Deprecated.
- 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. - 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(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. - 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) - Method in class org.apache.commons.cli.HelpFormatter
-
Print the cmdLineSyntax to the specified writer, using the specified width.
- printUsage(PrintWriter, int, String, Options) - 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
-
Print the specified text to the specified PrintWriter.
- printWrapped(PrintWriter, int, String) - Method in class org.apache.commons.cli.HelpFormatter
-
Print the specified text to the specified PrintWriter.
- processArgs(Option, ListIterator<String>) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Process the argument values for the specified Option
opt
using the values retrieved from the specified iteratoriter
. - processNonOptionToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser
-
Deprecated.Add the special token "--" and the current
value
to the processed tokens list. - processOption(String, ListIterator<String>) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Process the Option specified by
arg
using the values retrieved from the specified iteratoriter
. - processOptionToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser
-
Deprecated.If an
Option
exists fortoken
then add the token to the processed list. - processProperties(Properties) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Sets the values of Options using the values in
properties
. - processValue(String) - Method in class org.apache.commons.cli.Option
-
Processes the value.
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.
- renderWrappedTextBlock(StringBuffer, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
-
Render the specified text width a maximum width.
- required - Variable in class org.apache.commons.cli.Option.Builder
-
specifies whether this option is required to be present
- required - Variable in class org.apache.commons.cli.Option
-
specifies whether this option is required to be present
- required - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.is required?
- required - Variable in class org.apache.commons.cli.OptionGroup
-
specified whether this group is required
- required() - Method in class org.apache.commons.cli.Option.Builder
-
Marks this Option as required.
- required(boolean) - Method in class org.apache.commons.cli.Option.Builder
-
Sets whether the Option is mandatory.
- requiredOptions - Variable in class org.apache.commons.cli.Parser
-
Deprecated.list of required options strings
- requiredOpts - Variable in class org.apache.commons.cli.Options
-
a map of the required options
- requiresArg() - Method in class org.apache.commons.cli.Option
-
Tells if the option requires more arguments to be valid.
- reset() - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.Resets the member variables to their default values.
- resolveOption(String) - Method in class org.apache.commons.cli.CommandLine
-
Retrieves the option object given the long or short option as a String
- rtrim(String) - Method in class org.apache.commons.cli.HelpFormatter
-
Remove the trailing whitespace from the specified String.
S
- selected - Variable in class org.apache.commons.cli.OptionGroup
-
the name of the selected option
- serialVersionUID - Static variable in exception org.apache.commons.cli.AlreadySelectedException
-
This exception
serialVersionUID
. - serialVersionUID - Static variable in exception org.apache.commons.cli.AmbiguousOptionException
-
This exception
serialVersionUID
. - serialVersionUID - Static variable in class org.apache.commons.cli.CommandLine
-
The serial version UID.
- serialVersionUID - Static variable in class org.apache.commons.cli.HelpFormatter.OptionComparator
-
The serial version UID.
- serialVersionUID - Static variable in exception org.apache.commons.cli.MissingArgumentException
-
This exception
serialVersionUID
. - serialVersionUID - Static variable in exception org.apache.commons.cli.MissingOptionException
-
This exception
serialVersionUID
. - serialVersionUID - Static variable in class org.apache.commons.cli.Option
-
The serial version UID.
- serialVersionUID - Static variable in class org.apache.commons.cli.OptionGroup
-
The serial version UID.
- serialVersionUID - Static variable in class org.apache.commons.cli.Options
-
The serial version UID.
- serialVersionUID - Static variable in exception org.apache.commons.cli.ParseException
-
This exception
serialVersionUID
. - serialVersionUID - Static variable in exception org.apache.commons.cli.UnrecognizedOptionException
-
This exception
serialVersionUID
. - 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'.
- setLongOptSeparator(String) - Method in class org.apache.commons.cli.HelpFormatter
-
Set the separator displayed between a long option and its value.
- 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.
- setOptionComparator(Comparator<Option>) - Method in class org.apache.commons.cli.HelpFormatter
-
Set the comparator used to sort the options when they output in help text.
- setOptions(Options) - Method in class org.apache.commons.cli.Parser
-
Deprecated.
- 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(Class<?>) - Method in class org.apache.commons.cli.Option
-
Sets the type of this Option.
- setType(Object) - Method in class org.apache.commons.cli.Option
-
Deprecated.since 1.3, use
Option.setType(Class)
instead - 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
- skipParsing - Variable in class org.apache.commons.cli.DefaultParser
-
Flag indicating if tokens should no longer be analyzed and simply added as arguments of the command line.
- stopAtNonOption - Variable in class org.apache.commons.cli.DefaultParser
-
Flag indicating how unrecognized tokens are handled.
- 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 beginning of
str
and return the new String.
T
- tokens - Variable in class org.apache.commons.cli.PosixParser
-
Deprecated.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 - Variable in class org.apache.commons.cli.Option.Builder
-
the type of this Option
- type - Variable in class org.apache.commons.cli.Option
-
the type of this Option
- type - Static variable in class org.apache.commons.cli.OptionBuilder
-
Deprecated.option type
- type(Class<?>) - Method in class org.apache.commons.cli.Option.Builder
-
Sets the type of the Option.
- TypeHandler - Class in org.apache.commons.cli
-
This is a temporary implementation.
- TypeHandler() - Constructor for class org.apache.commons.cli.TypeHandler
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
- UnrecognizedOptionException - Exception in org.apache.commons.cli
-
Exception thrown during parsing signalling an unrecognized option was seen.
- UnrecognizedOptionException(String) - Constructor for exception org.apache.commons.cli.UnrecognizedOptionException
-
Construct a new
UnrecognizedArgumentException
with the specified detail message. - UnrecognizedOptionException(String, String) - Constructor for exception org.apache.commons.cli.UnrecognizedOptionException
-
Construct a new
UnrecognizedArgumentException
with the specified option and detail message. - updateRequiredOptions(Option) - Method in class org.apache.commons.cli.DefaultParser
-
Removes the option or its group from the list of expected elements.
- updateRequiredOptions(Option) - Method in class org.apache.commons.cli.Parser
-
Deprecated.Removes the option or its group from the list of expected elements.
- URL_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
-
URL class
- Util - Class in org.apache.commons.cli
-
Contains useful helper methods for classes within this package.
- Util() - Constructor for class org.apache.commons.cli.Util
V
- validateOption(String) - Static method in class org.apache.commons.cli.OptionValidator
-
Validates whether
opt
is a permissible 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.Builder
-
the character that is the value separator
- 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
-
Deprecated.value separator for argument value
- valueSeparator() - Method in class org.apache.commons.cli.Option.Builder
-
The Option will use '=' as a means to separate argument value.
- valueSeparator(char) - Method in class org.apache.commons.cli.Option.Builder
-
The Option will use
sep
as a means to separate argument values.
W
- withArgName(String) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option created will have the specified argument value name.
- withDescription(String) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option created will have the specified description
- withLongOpt(String) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option created will have the following long option value.
- withType(Class<?>) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option created will have a value that will be an instance of
type
. - withType(Object) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.since 1.3, use
OptionBuilder.withType(Class)
instead - withValueSeparator() - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option created uses '
=
' as a means to separate argument values. - withValueSeparator(char) - Static method in class org.apache.commons.cli.OptionBuilder
-
Deprecated.The next Option created uses
sep
as a means to separate argument values.
All Classes All Packages