Index

A B C D E F G H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractHelpFormatter - Class in org.apache.commons.cli.help
Helps formatters provides the framework to link a HelpAppendable with a OptionFormatter and a default TableDefinition so to produce standardized format help output.
AbstractHelpFormatter(AbstractHelpFormatter.Builder<?, ?>) - Constructor for class org.apache.commons.cli.help.AbstractHelpFormatter
Constructs the base formatter.
AbstractHelpFormatter.Builder<B,T> - Class in org.apache.commons.cli.help
Abstracts building instances for subclasses.
acceptsArg() - Method in class org.apache.commons.cli.Option
Tests whether the option can accept more arguments.
add(String) - Method in class org.apache.commons.cli.Option
Adds the value to this Option.
addArg(String) - Method in class org.apache.commons.cli.CommandLine
Adds left-over unrecognized option/argument.
addArg(String) - Method in class org.apache.commons.cli.CommandLine.Builder
Adds left-over unrecognized option/argument.
addArg(String) - Method in class org.apache.commons.cli.DefaultParser
Adds token to command line CommandLine.addArg(String).
ADDITIONAL_LONG_CHARS - Static variable in class org.apache.commons.cli.OptionValidator
The array of additional characters allowed in the rest of the option but not in the first position
ADDITIONAL_OPTION_CHARS - Static variable in class org.apache.commons.cli.OptionValidator
The array of additional characters allowed as the first character in the option but not in the rest of the option
addOption(String, boolean, String) - Method in class org.apache.commons.cli.Options
Adds an option that only contains a short-name.
addOption(String, String) - Method in class org.apache.commons.cli.Options
Adds an option that only contains a short name.
addOption(String, String, boolean, String) - Method in class org.apache.commons.cli.Options
Adds an option that contains a short-name and a long-name.
addOption(Option) - Method in class org.apache.commons.cli.CommandLine
Adds an option to the command line.
addOption(Option) - Method in class org.apache.commons.cli.CommandLine.Builder
Adds an option to the command line.
addOption(Option) - Method in class org.apache.commons.cli.OptionGroup
Adds the given 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
Adds the specified option group.
addOptions(Options) - Method in class org.apache.commons.cli.Options
Adds options to this option.
addRemaining(Iterator<String>) - Method in class org.apache.commons.cli.PosixParser
Deprecated.
Adds the remaining tokens to the processed tokens list.
addRequiredOption(String, String, boolean, String) - Method in class org.apache.commons.cli.Options
Adds an option that contains a short-name and a long-name.
addValue(String) - Method in class org.apache.commons.cli.Option
Deprecated.
Unused.
adjustTableFormat(TableDefinition) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Adjusts the table format.
alignment - Variable in class org.apache.commons.cli.help.TextStyle
The alignment.
alignment - Variable in class org.apache.commons.cli.help.TextStyle.Builder
The alignment.
Alignment() - Constructor for enum org.apache.commons.cli.help.TextStyle.Alignment
 
allowPartialMatching - Variable in class org.apache.commons.cli.DefaultParser
Flag indicating if partial matching of long options is supported.
allowPartialMatching - Variable in class org.apache.commons.cli.DefaultParser.Builder
Flag indicating if partial matching of long options is supported.
AlreadySelectedException - Exception Class in org.apache.commons.cli
Thrown when more than one option in an option group has been provided.
AlreadySelectedException(String) - Constructor for exception class org.apache.commons.cli.AlreadySelectedException
Constructs a new AlreadySelectedException with the specified detail message.
AlreadySelectedException(String, OptionGroup, Option) - Constructor for exception class org.apache.commons.cli.AlreadySelectedException
 
AlreadySelectedException(OptionGroup, Option) - Constructor for exception class org.apache.commons.cli.AlreadySelectedException
Constructs a new AlreadySelectedException for the specified option group.
AmbiguousOptionException - Exception Class 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 class org.apache.commons.cli.AmbiguousOptionException
Constructs a new AmbiguousOptionException.
APOS - Static variable in class org.apache.commons.cli.Char
Apostrophe
append(char) - Method in class org.apache.commons.cli.help.FilterHelpAppendable
 
append(CharSequence) - Method in class org.apache.commons.cli.help.FilterHelpAppendable
 
append(CharSequence, int, int) - Method in class org.apache.commons.cli.help.FilterHelpAppendable
 
appendFormat(String, Object...) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a formatted string using the specified format string and arguments.
appendHeader(int, CharSequence) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a header.
appendHeader(int, CharSequence) - Method in class org.apache.commons.cli.help.TextHelpAppendable
 
appendList(boolean, Collection<CharSequence>) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a list.
appendList(boolean, Collection<CharSequence>) - Method in class org.apache.commons.cli.help.TextHelpAppendable
 
appendOption(StringBuilder, Option, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Appends the usage clause for an Option to a StringBuffer.
appendOptionGroup(StringBuilder, OptionGroup) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Appends the usage clause for an OptionGroup to a StringBuffer.
appendOptions(A, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Renders the specified Options and return the rendered Options in a StringBuffer.
appendParagraph(CharSequence) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a paragraph.
appendParagraph(CharSequence) - Method in class org.apache.commons.cli.help.TextHelpAppendable
 
appendParagraphFormat(String, Object...) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a formatted string as a paragraph.
appendTable(TableDefinition) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a table.
appendTable(TableDefinition) - Method in class org.apache.commons.cli.help.TextHelpAppendable
 
appendTitle(CharSequence) - Method in interface org.apache.commons.cli.help.HelpAppendable
Appends a title.
appendTitle(CharSequence) - Method in class org.apache.commons.cli.help.TextHelpAppendable
 
appendWrappedText(A, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Renders the specified text and return the rendered Options in a StringBuffer.
apply(String) - Method in interface org.apache.commons.cli.Converter
Applies the conversion function to the String argument.
argCount - Variable in class org.apache.commons.cli.Option
The number of argument values this option can have.
argCount - Variable in class org.apache.commons.cli.Option.Builder
The number of argument values this option can have.
argCount - Static variable in class org.apache.commons.cli.OptionBuilder
Deprecated.
The number of arguments.
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.
argNameDelimiters - Variable in class org.apache.commons.cli.help.OptionFormatter
The delimiters around argument names.
argNameDelimiters - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The argument name delimiters
args - Variable in class org.apache.commons.cli.CommandLine
The unrecognized options/arguments
args - Variable in class org.apache.commons.cli.CommandLine.Builder
The unrecognized options/arguments
asThis() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Returns this instance cast to B.

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.
Constructs a new instance.
BLANK_LINE - Static variable in class org.apache.commons.cli.help.TextHelpAppendable
A blank line in the output: "".
BREAK_CHAR_SET - Static variable in class org.apache.commons.cli.help.TextHelpAppendable
The set of characters that are breaks in text.
build() - Method in class org.apache.commons.cli.CommandLine.Builder
Deprecated.
build() - Method in class org.apache.commons.cli.DefaultParser.Builder
Deprecated.
build() - Method in class org.apache.commons.cli.Option.Builder
Deprecated.
build(Option) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Build an OptionFormatter to format the specified option.
builder() - Static method in class org.apache.commons.cli.CommandLine
Creates a new builder.
builder() - Static method in class org.apache.commons.cli.DefaultParser
Creates a new DefaultParser.Builder to create an DefaultParser using descriptive methods.
builder() - Static method in class org.apache.commons.cli.DeprecatedAttributes
Creates a new builder.
builder() - Static method in class org.apache.commons.cli.help.HelpFormatter
Constructs a new builder.
builder() - Static method in class org.apache.commons.cli.help.OptionFormatter
Creates a new builder.
builder() - Static method in class org.apache.commons.cli.help.TextStyle
Creates a new builder.
builder() - Static method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Creates a new builder.
builder() - Static method in class org.apache.commons.cli.Option
Returns a Option.Builder to create an Option using descriptive methods.
builder(String) - Static method in class org.apache.commons.cli.Option
Returns a Option.Builder to create an Option using descriptive methods.
Builder() - Constructor for class org.apache.commons.cli.CommandLine.Builder
Deprecated.
Builder() - Constructor for class org.apache.commons.cli.DefaultParser.Builder
Constructs a new Builder for a DefaultParser instance.
Builder() - Constructor for class org.apache.commons.cli.DeprecatedAttributes.Builder
Builder() - Constructor for class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Constructs a new instance.
Builder() - Constructor for class org.apache.commons.cli.help.HelpFormatter.Builder
Constructs a new instace.
Builder() - Constructor for class org.apache.commons.cli.help.OptionFormatter.Builder
Default constructor.
Builder() - Constructor for class org.apache.commons.cli.help.TextStyle.Builder
Constructs a new instance.
Builder() - Constructor for class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
Constructs a new instance.
Builder(String) - Constructor for class org.apache.commons.cli.Option.Builder
Constructs a new Builder with the minimum required parameters for an Option instance.
Builder(OptionFormatter) - Constructor for class org.apache.commons.cli.help.OptionFormatter.Builder
Constructor that takes the arguments from the supplied OptionFormatter
burstToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser
Deprecated.
Breaks token into its constituent parts using the following algorithm.

C

caption() - Method in interface org.apache.commons.cli.help.TableDefinition
Gets the caption for the table.
CENTER - Enum constant in enum org.apache.commons.cli.help.TextStyle.Alignment
Centers the text.
Char - Class in org.apache.commons.cli
Package-private character constants.
Char() - Constructor for class org.apache.commons.cli.Char
 
checkRequiredArgs() - Method in class org.apache.commons.cli.DefaultParser
Throws 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 - Static variable in interface org.apache.commons.cli.Converter
Class name converter.
CLASS_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
Class class
clearValues() - Method in class org.apache.commons.cli.Option
Clears 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 compatible 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
columnTextStyles() - Method in interface org.apache.commons.cli.help.TableDefinition
Gets the list TextStyles.
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(List<String>, List<Option>, Consumer<Option>) - 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 the Options specified and return a CommandLine.
comparator - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
The comparator to sort lists of options
comparator - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The comparator for sorting Option collections
compare(Option, Option) - Method in class org.apache.commons.cli.HelpFormatter.OptionComparator
Deprecated.
Compares its two arguments for order.
COMPLEX_DEPRECATED_FORMAT - Static variable in class org.apache.commons.cli.help.OptionFormatter
A function to display a deprecated option with a "Deprecated" prefix that displays all deprecation information.
converter - Variable in class org.apache.commons.cli.Option.Builder
The converter to convert to type.
converter - Variable in class org.apache.commons.cli.Option
The explicit converter for this option.
converter(Converter<?, ?>) - Method in class org.apache.commons.cli.Option.Builder
Sets the converter for the option.
Converter<T,E> - Interface in org.apache.commons.cli
The definition of the functional interface to call when doing a conversion.
converterMap - Variable in class org.apache.commons.cli.TypeHandler
Map of Class to Converter.
CR - Static variable in class org.apache.commons.cli.Char
Carriage return.
create() - Static method in class org.apache.commons.cli.OptionBuilder
Deprecated.
Creates an Option using the current settings.
create(char) - Static method in class org.apache.commons.cli.OptionBuilder
Deprecated.
Creates an Option using the current settings and with the specified Option char.
create(String) - Static method in class org.apache.commons.cli.OptionBuilder
Deprecated.
Creates 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 string.
createDefaultMap() - Static method in class org.apache.commons.cli.TypeHandler
Creates a default converter map.
createDefaultPrintWriter() - Static method in class org.apache.commons.cli.HelpFormatter
Deprecated.
 
createFile(String) - Static method in class org.apache.commons.cli.TypeHandler
Returns the File represented by string.
createFiles(String) - Static method in class org.apache.commons.cli.TypeHandler
Deprecated.
Without replacement.
createMessage(String, Collection<String>) - Static method in exception class org.apache.commons.cli.AmbiguousOptionException
Build the exception message from the specified list of options.
createMessage(List<?>) - Static method in exception class 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
Deprecated.
createObject(String) - Static method in class org.apache.commons.cli.TypeHandler
createPadding(int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Creates a String of padding of length len.
createURL(String) - Static method in class org.apache.commons.cli.TypeHandler
Creates the URL represented by string.
createValue(String, Class<T>) - Static method in class org.apache.commons.cli.TypeHandler
Creates the @code Object} of type clazz with the value of string.
createValue(String, Object) - Static method in class org.apache.commons.cli.TypeHandler
createValueUnchecked(String, Class<T>) - Static method in class org.apache.commons.cli.TypeHandler
Delegates to TypeHandler.createValue(String, Class) throwing IllegalArgumentException instead of ParseException.
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 - Static variable in interface org.apache.commons.cli.Converter
Converts to a date using the format string Form "EEE MMM dd HH:mm:ss zzz yyyy".
DATE_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
Date class
DEFAULT - Static variable in interface org.apache.commons.cli.Converter
The default converter.
DEFAULT - Static variable in class org.apache.commons.cli.DeprecatedAttributes
The default value for a DeprecatedAttributes.
DEFAULT - Static variable in class org.apache.commons.cli.help.TextStyle
The default style as generated by the default Builder.
DEFAULT - Static variable in class org.apache.commons.cli.TypeHandler
The default TypeHandler.
DEFAULT_ARG_NAME - Static variable in class org.apache.commons.cli.help.OptionFormatter
The default argument name: "arg".
DEFAULT_ARG_NAME - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Default name for an argument
DEFAULT_ARG_NAME_DELIMITERS - Static variable in class org.apache.commons.cli.help.OptionFormatter
The default delimiters for an argument name
DEFAULT_COLUMN_SPACING - Static variable in class org.apache.commons.cli.help.HelpFormatter
The default number of spaces between columns in the options table: 5.
DEFAULT_COMPARATOR - Static variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The default comparator for Option implementations.
DEFAULT_DEPRECATED_FORMAT - Static variable in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
A function to convert a description (not null) and a deprecated Option (not null) to help description
DEFAULT_DESC_PAD - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Number of space characters to be prefixed to each description line
DEFAULT_INDENT - Static variable in class org.apache.commons.cli.help.TextHelpAppendable
The number of space characters to be prefixed to each description line: 3.
DEFAULT_LEFT_PAD - Static variable in class org.apache.commons.cli.help.HelpFormatter
Default padding to the left of each line: 1.
DEFAULT_LEFT_PAD - Static variable in class org.apache.commons.cli.help.TextHelpAppendable
The default padding to the left of each line: 1.
DEFAULT_LEFT_PAD - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Default padding to the left of each line
DEFAULT_LIST_INDENT - Static variable in class org.apache.commons.cli.help.TextHelpAppendable
The number of space characters before a list continuation line: 7.
DEFAULT_LONG_OPT_PREFIX - Static variable in class org.apache.commons.cli.help.OptionFormatter
Default prefix for long options: "--".
DEFAULT_LONG_OPT_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Default prefix for long Option
DEFAULT_LONG_OPT_SEPARATOR - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Default separator displayed between a long Option and its value
DEFAULT_OPT_ARG_SEPARATOR - Static variable in class org.apache.commons.cli.help.OptionFormatter
The default separator between the opt and/or longOpt and the argument name: " ".
DEFAULT_OPT_PREFIX - Static variable in class org.apache.commons.cli.help.OptionFormatter
Default prefix for short options: "-".
DEFAULT_OPT_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Default prefix for shortOpts
DEFAULT_OPT_SEPARATOR - Static variable in class org.apache.commons.cli.help.OptionFormatter
The default separator between options: ", ".
DEFAULT_OPTION_GROUP_SEPARATOR - Static variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The default separator between OptionGroup elements: " | ".
DEFAULT_OPTIONAL_DELIMITERS - Static variable in class org.apache.commons.cli.help.OptionFormatter
The default delimiters for optional arguments
DEFAULT_SYNTAX_PREFIX - Static variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The string to display at the beginning of the usage statement: "usage: ".
DEFAULT_SYNTAX_PREFIX - Static variable in class org.apache.commons.cli.help.OptionFormatter
The string to display at the beginning of the usage statement: "usage: ".
DEFAULT_SYNTAX_PREFIX - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
The string to display at the beginning of the usage statement
DEFAULT_TYPE - Static variable in class org.apache.commons.cli.Option.Builder
The default type.
DEFAULT_WIDTH - Static variable in class org.apache.commons.cli.help.HelpFormatter
Default number of characters per line: 74.
DEFAULT_WIDTH - Static variable in class org.apache.commons.cli.help.TextHelpAppendable
The default number of characters per line: 74.
DEFAULT_WIDTH - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Default number of characters per line
defaultArgName - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The default argument name
defaultArgName - Variable in class org.apache.commons.cli.help.OptionFormatter
The default argument name.
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
Creates a new DefaultParser instance with partial matching enabled.
DefaultParser(boolean) - Constructor for class org.apache.commons.cli.DefaultParser
Create a new DefaultParser instance with the specified partial matching policy.
DefaultParser(boolean, Boolean, Consumer<Option>) - Constructor for class org.apache.commons.cli.DefaultParser
Creates a new DefaultParser instance with the specified partial matching and quote stripping policy.
DefaultParser.Builder - Class in org.apache.commons.cli
A nested builder class to create DefaultParser instances using descriptive methods.
DefaultParser.NonOptionAction - Enum in org.apache.commons.cli
Enum representing possible actions that may be done when "non option" is discovered during parsing.
defaultSyntaxPrefix - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Scope will be made private for next major version - use get/setSyntaxPrefix methods instead.
defaultValue(T, T) - Static method in class org.apache.commons.cli.help.Util
Returns the defaultValue if str is empty.
defaultWidth - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Scope will be made private for next major version - use get/setWidth methods instead.
deprecated - Variable in class org.apache.commons.cli.Option.Builder
Specifies whether this option is deprecated.
deprecated - Variable in class org.apache.commons.cli.Option
Specifies whether this option is deprecated, may be null.
deprecated() - Method in class org.apache.commons.cli.Option.Builder
Marks this Option as deprecated.
deprecated(DeprecatedAttributes) - Method in class org.apache.commons.cli.Option.Builder
Sets whether the Option is deprecated.
DEPRECATED_HANDLER - Static variable in class org.apache.commons.cli.CommandLine.Builder
Prints an Option to System.out.
DeprecatedAttributes - Class in org.apache.commons.cli
Deprecated attributes.
DeprecatedAttributes(String, String, boolean) - Constructor for class org.apache.commons.cli.DeprecatedAttributes
Constructs a new instance.
DeprecatedAttributes.Builder - Class in org.apache.commons.cli
deprecatedFormatFunction - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The function to create the deprecated message for an option
deprecatedFormatFunction - Variable in class org.apache.commons.cli.help.OptionFormatter
The function to display the deprecated option message.
deprecatedFormatFunction - Variable in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
Formatter for deprecated options.
deprecatedFormatFunction - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Function to format the description for a deprecated option.
deprecatedHandler - Variable in class org.apache.commons.cli.CommandLine.Builder
Deprecated Option handler.
deprecatedHandler - Variable in class org.apache.commons.cli.CommandLine
The deprecated option handler.
deprecatedHandler - Variable in class org.apache.commons.cli.DefaultParser.Builder
The deprecated option handler.
deprecatedHandler - Variable in class org.apache.commons.cli.DefaultParser
The deprecated option handler.
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.DeprecatedAttributes.Builder
The description.
description - Variable in class org.apache.commons.cli.DeprecatedAttributes
The description.
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.
determineMaxSinceLength(Options) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
 

E

eatTheRest - Variable in class org.apache.commons.cli.PosixParser
Deprecated.
Specifies if bursting should continue..
EMPTY_ARRAY - Static variable in class org.apache.commons.cli.Option
Empty array.
EMPTY_STRING - Static variable in class org.apache.commons.cli.DeprecatedAttributes
The empty string.
EMPTY_STRING_ARRAY - Static variable in class org.apache.commons.cli.Util
An empty immutable String array.
EQUAL - Static variable in class org.apache.commons.cli.Char
Equal sign.
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 - Static variable in interface org.apache.commons.cli.Converter
File name converter.
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
FilterHelpAppendable - Class in org.apache.commons.cli.help
An abstract implementation of HelpAppendable that writes output to an Appendable instance.
FilterHelpAppendable(Appendable) - Constructor for class org.apache.commons.cli.help.FilterHelpAppendable
Constructs an appendable filter built on top of the specified underlying appendable.
findWrapPos(String, int, int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Finds the next text wrap position after startPos for the text in text with the column width width.
first(String[]) - Method in class org.apache.commons.cli.CommandLine
Gets the first element or null if values is null.
flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.BasicParser
Deprecated.
A simple implementation of Parser's abstract flatten method.
flatten(Options, String[], boolean) - Method in class org.apache.commons.cli.GnuParser
Deprecated.
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 for example "-D" and add the rest of the entry to the also. Otherwise just add the token to the processed tokens list.
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.
An implementation of Parser's abstract flatten method.
forRemoval - Variable in class org.apache.commons.cli.DeprecatedAttributes.Builder
Whether this option is subject to removal in a future version.
forRemoval - Variable in class org.apache.commons.cli.DeprecatedAttributes
Whether this option will be removed.
from(String, List<TextStyle>, List<String>, Iterable<List<String>>) - Static method in interface org.apache.commons.cli.help.TableDefinition
A helper function to create a table instance from the various components.
from(Option) - Static method in class org.apache.commons.cli.help.OptionFormatter
Construct the OptionFormatter from an Option using the default OptionFormatter.Builder.

G

get() - Method in class org.apache.commons.cli.CommandLine.Builder
Creates a new instance.
get() - Method in class org.apache.commons.cli.DefaultParser.Builder
Builds an DefaultParser with the values declared by this DefaultParser.Builder.
get() - Method in class org.apache.commons.cli.DeprecatedAttributes.Builder
 
get() - Method in class org.apache.commons.cli.help.HelpFormatter.Builder
 
get() - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
 
get() - Method in class org.apache.commons.cli.help.TextStyle.Builder
 
get() - Method in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
 
get() - Method in class org.apache.commons.cli.Option.Builder
Constructs an Option with the values declared by this Option.Builder.
get(Supplier<T>) - Method in class org.apache.commons.cli.CommandLine
 
getAlignment() - Method in class org.apache.commons.cli.help.TextStyle
Gets the alignment.
getArgList() - Method in class org.apache.commons.cli.CommandLine
Gets any left-over non-recognized options and arguments.
getArgName() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the argument name wrapped in the argument name delimiters.
getArgName() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets 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
Gets any left-over non-recognized options and arguments.
getArgs() - Method in class org.apache.commons.cli.Option
Gets the number of argument values this Option can take.
getBothOpt() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets both options separated by the specified option separator.
getComparator() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Gets the comparator to sort lists of options.
getComparator() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Gets the comparator for sorting options.
getConverter() - Method in class org.apache.commons.cli.Option
Gets the value to type converter.
getConverter(Class<T>) - Method in class org.apache.commons.cli.TypeHandler
Gets the registered converter for the the Class, or Converter.DEFAULT if absent.
getDefault() - Static method in class org.apache.commons.cli.TypeHandler
Gets the default TypeHandler.
getDeprecated() - Method in class org.apache.commons.cli.Option
Gets deprecated attributes if any.
getDescPadding() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the 'descPadding'.
getDescription() - Method in class org.apache.commons.cli.DeprecatedAttributes
Gets the descriptions.
getDescription() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the description for the option.
getDescription() - Method in class org.apache.commons.cli.Option
Gets the self-documenting description of this Option.
getDescription(Option) - Static method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the option description or an empty string if the description is null.
getHelpAppendable() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
getHelpAppendable() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Gets the help appendable.
getId() - Method in class org.apache.commons.cli.Option
Gets the id of this Option.
getIndent() - Method in class org.apache.commons.cli.help.TextHelpAppendable
Gets the indent for the output.
getIndent() - Method in class org.apache.commons.cli.help.TextStyle.Builder
Gets the currently specified indent value.
getIndent() - Method in class org.apache.commons.cli.help.TextStyle
Gets the indent value.
getKey() - Method in class org.apache.commons.cli.Option
Gets the 'unique' Option identifier.
getLeftPad() - Method in class org.apache.commons.cli.help.TextHelpAppendable
Returns the left padding for the output.
getLeftPad() - Method in class org.apache.commons.cli.help.TextStyle.Builder
Gets the currently specified leftPad.
getLeftPad() - Method in class org.apache.commons.cli.help.TextStyle
Gets the left padding.
getLeftPadding() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the 'leftPadding'.
getLongOpt() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the long Opt from the @{link Option} with the associate prefix.
getLongOpt() - Method in class org.apache.commons.cli.Option
Gets the long name of this Option.
getLongOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the 'longOptPrefix'.
getLongOptSeparator() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the separator displayed between a long option and its value.
getLongPrefix(String) - Method in class org.apache.commons.cli.DefaultParser
Searches for a prefix that is the long name of an option (-Xmx512m).
getMatchingLongOptions(String) - Method in class org.apache.commons.cli.DefaultParser
Gets a list of matching option strings for the given token, depending on the selected partial matching policy.
getMatchingOptions() - Method in exception class org.apache.commons.cli.AmbiguousOptionException
Gets the options matching the partial name.
getMatchingOptions(String) - Method in class org.apache.commons.cli.Options
Gets the options with a long name starting with the name specified.
getMaxWidth() - Method in class org.apache.commons.cli.help.TextHelpAppendable
Gets the maximum width for the output
getMaxWidth() - Method in class org.apache.commons.cli.help.TextStyle.Builder
Gets the currently specified maximum width value.
getMaxWidth() - Method in class org.apache.commons.cli.help.TextStyle
gets the maximum width.
getMinWidth() - Method in class org.apache.commons.cli.help.TextStyle.Builder
Gets the currently specified minimum width value.
getMinWidth() - Method in class org.apache.commons.cli.help.TextStyle
gets the minimum width.
getMissingOptions() - Method in exception class org.apache.commons.cli.MissingOptionException
Gets the list of options or option groups missing in the command line parsed.
getNames() - Method in class org.apache.commons.cli.OptionGroup
Gets the names of the options in this group as a Collection.
getNewLine() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the 'newLine'.
getOpt() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the Opt from the @{link Option} with the associate prefix.
getOpt() - Method in class org.apache.commons.cli.Option
Gets the name of this Option.
getOption() - Method in exception class org.apache.commons.cli.AlreadySelectedException
Gets the option that was added to the group and triggered the exception.
getOption() - Method in exception class org.apache.commons.cli.MissingArgumentException
Gets the option requiring an argument that wasn't provided on the command line.
getOption() - Method in exception class org.apache.commons.cli.UnrecognizedOptionException
Gets the unrecognized option.
getOption(String) - Method in class org.apache.commons.cli.Options
Gets the Option matching the long or short name specified.
getOptionComparator() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Comparator used to sort the options when they output in help text.
getOptionCount(char) - Method in class org.apache.commons.cli.CommandLine
Gets the number of times this option appears in the command line
getOptionCount(String) - Method in class org.apache.commons.cli.CommandLine
Gets the number of times this option appears in the command line
getOptionCount(Option) - Method in class org.apache.commons.cli.CommandLine
Gets the number of times this option appears in the command line.
getOptionFormatBuilder() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Gets OptionFormatter.Builder to use to format options in the table.
getOptionFormatBuilder() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Gets the option formatter builder.
getOptionFormatter(Option) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Constructs an OptionFormatter for the specified Option.
getOptionGroup() - Method in exception class org.apache.commons.cli.AlreadySelectedException
Gets the option group where another option has been selected.
getOptionGroup(Option) - Method in class org.apache.commons.cli.Options
Gets the OptionGroup the opt belongs to.
getOptionGroups() - Method in class org.apache.commons.cli.Options
Gets the OptionGroups that are members of this Options instance.
getOptionGroupSeparator() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Gets string to separate option groups.
getOptionGroupSeparator() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Gets the option group separator.
getOptionObject(char) - Method in class org.apache.commons.cli.CommandLine
Deprecated.
due to System.err message; use CommandLine.getParsedOptionValue(char) instead.
getOptionObject(String) - Method in class org.apache.commons.cli.CommandLine
Deprecated.
due to System.err message; use CommandLine.getParsedOptionValue(String) instead.
getOptionProperties(String) - Method in class org.apache.commons.cli.CommandLine
Gets the map of values associated to the option.
getOptionProperties(Option) - Method in class org.apache.commons.cli.CommandLine
Gets the map of values associated to the option.
getOptions() - Method in class org.apache.commons.cli.CommandLine
Gets an array of the processed Options.
getOptions() - Method in class org.apache.commons.cli.OptionGroup
Gets the options in this group as a Collection.
getOptions() - Method in class org.apache.commons.cli.Options
Gets a read-only list of options in this set.
getOptions() - Method in class org.apache.commons.cli.Parser
Deprecated.
Gets the options.
getOptionValue(char) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of this option.
getOptionValue(char, String) - Method in class org.apache.commons.cli.CommandLine
Gets the argument, if any, of an option.
getOptionValue(char, Supplier<String>) - Method in class org.apache.commons.cli.CommandLine
Gets the argument, if any, of an option.
getOptionValue(String) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of this option.
getOptionValue(String, String) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of an option.
getOptionValue(String, Supplier<String>) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of an option.
getOptionValue(Option) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of this option.
getOptionValue(OptionGroup) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of this option group.
getOptionValue(OptionGroup, String) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of an option group.
getOptionValue(OptionGroup, Supplier<String>) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of an option group.
getOptionValue(Option, String) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of an option.
getOptionValue(Option, Supplier<String>) - Method in class org.apache.commons.cli.CommandLine
Gets the first argument, if any, of an option.
getOptionValues(char) - Method in class org.apache.commons.cli.CommandLine
Gets the array of values, if any, of an option.
getOptionValues(String) - Method in class org.apache.commons.cli.CommandLine
Gets the array of values, if any, of an option.
getOptionValues(Option) - Method in class org.apache.commons.cli.CommandLine
Gets the array of values, if any, of an option.
getOptionValues(OptionGroup) - Method in class org.apache.commons.cli.CommandLine
Gets the array of values, if any, of an option group.
getOptPrefix() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the 'optPrefix'.
getParsedOptionValue(char) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(char, Supplier<T>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(char, T) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(String) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(String, Supplier<T>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(String, T) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(Option) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(OptionGroup) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this OptionGroup converted to a particular type.
getParsedOptionValue(OptionGroup, Supplier<T>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this OptionGroup converted to a particular type.
getParsedOptionValue(OptionGroup, T) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this OptionGroup converted to a particular type.
getParsedOptionValue(Option, Supplier<T>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValue(Option, T) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to a particular type.
getParsedOptionValues(char) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(char, Supplier<T[]>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(char, T[]) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(String) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(String, Supplier<T[]>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(String, T[]) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(Option) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(OptionGroup) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this OptionGroup converted to an array of a particular type.
getParsedOptionValues(OptionGroup, Supplier<T[]>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this OptionGroup converted to an array of a particular type.
getParsedOptionValues(OptionGroup, T[]) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this OptionGroup converted to an array of a particular type.
getParsedOptionValues(Option, Supplier<T[]>) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getParsedOptionValues(Option, T[]) - Method in class org.apache.commons.cli.CommandLine
Gets a version of this Option converted to an array of a particular type.
getRequiredOptions() - Method in class org.apache.commons.cli.Options
Gets the required options.
getRequiredOptions() - Method in class org.apache.commons.cli.Parser
Deprecated.
Gets the required options.
getSelected() - Method in class org.apache.commons.cli.OptionGroup
Gets the selected option name.
getSerializer() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Gets the HelpAppendable associated with this help formatter.
getSince() - Method in class org.apache.commons.cli.DeprecatedAttributes
Gets version in which the option became deprecated.
getSince() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the "since" value from the Option.
getSince() - Method in class org.apache.commons.cli.Option
Gets the version when this option was added.
getSyntaxPrefix() - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Gets the currently set syntax prefix.
getSyntaxPrefix() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets the 'syntaxPrefix'.
getTableDefinition(Iterable<Option>) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Converts a collection of Options into a TableDefinition.
getTableDefinition(Iterable<Option>) - Method in class org.apache.commons.cli.help.HelpFormatter
Gets the table definition for the options.
getTextStyleBuilder() - Method in class org.apache.commons.cli.help.TextHelpAppendable
Gets the style builder used to format text that is not otherwise formatted.
getType() - Method in class org.apache.commons.cli.Option
Gets the type of this Option.
getValue() - Method in class org.apache.commons.cli.Option
Gets the specified value of this Option or null if there is no value.
getValue(int) - Method in class org.apache.commons.cli.Option
Gets the specified value of this Option or null if there is no value.
getValue(String) - Method in class org.apache.commons.cli.Option
Gets 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
getValues() - Method in class org.apache.commons.cli.Option
Gets the values of this Option as a String array or an empty array if there are no values.
getValueSeparator() - Method in class org.apache.commons.cli.Option
Gets the value separator character.
getValuesList() - Method in class org.apache.commons.cli.Option
Gets the values of this Option as a List.
getValueType(char) - Static method in class org.apache.commons.cli.PatternOptionBuilder
Retrieve the class that ch represents.
getWidth() - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Gets 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.
Constructs a new instance.

H

handleConcatenatedOptions(String) - Method in class org.apache.commons.cli.DefaultParser
Breaks token into its constituent parts using the following algorithm.
handleDeprecated(Option) - Method in class org.apache.commons.cli.CommandLine
Handles deprecated options.
handleLongOption(String) - Method in class org.apache.commons.cli.DefaultParser
Handles the following tokens:
handleLongOptionWithEqual(String) - Method in class org.apache.commons.cli.DefaultParser
Handles the following tokens:
handleLongOptionWithoutEqual(String) - Method in class org.apache.commons.cli.DefaultParser
Handles the following tokens:
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:
handleToken(String) - Method in class org.apache.commons.cli.DefaultParser
Handles 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
Tests whether the Option will require an argument.
hasArg() - Method in class org.apache.commons.cli.Option
Tests whether 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
Tests whether 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
Tests whether the display name for the argument value has been set.
hasArgs() - Method in class org.apache.commons.cli.Option.Builder
Tests whether the Option can have unlimited argument values.
hasArgs() - Method in class org.apache.commons.cli.Option
Tests whether 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
Tests whether this Option has a long name.
hasLongOption(String) - Method in class org.apache.commons.cli.Options
Tests whether the named Option is a member of this Options.
hasOption(char) - Method in class org.apache.commons.cli.CommandLine
Tests to see if an option has been set.
hasOption(String) - Method in class org.apache.commons.cli.CommandLine
Tests to see if an option has been set.
hasOption(String) - Method in class org.apache.commons.cli.Options
Tests whether the named Option is a member of this Options.
hasOption(Option) - Method in class org.apache.commons.cli.CommandLine
Tests to see if an option has been set.
hasOption(OptionGroup) - Method in class org.apache.commons.cli.CommandLine
Tests to see if an option has been set.
hasOptionalArg() - Method in class org.apache.commons.cli.Option
Tests whether this Option can have an optional argument.
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
Tests whether the named Option is a member of this Options.
hasValueSeparator() - Method in class org.apache.commons.cli.Option
Tests whether this Option has specified a value separator.
HEADER_DESCRIPTION - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
"Description" test for options header
HEADER_OPTIONS - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
"Options" text for options header
HEADER_SINCE - Static variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
"Since" text for options header
headers() - Method in interface org.apache.commons.cli.help.TableDefinition
Gets the list of header strings.
helpAppendable - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
helpAppendable - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The HelpAppendable that produces the final output.
HelpAppendable - Interface in org.apache.commons.cli.help
Defines a semantic scribe.
HelpFormatter - Class in org.apache.commons.cli.help
A default formatter implementation for standard usage.
HelpFormatter - Class in org.apache.commons.cli
Deprecated.
HelpFormatter() - Constructor for class org.apache.commons.cli.HelpFormatter
Deprecated.
Constructs a new instance.
HelpFormatter(Function<Option, String>, PrintWriter, boolean) - Constructor for class org.apache.commons.cli.HelpFormatter
Deprecated.
Constructs a new instance.
HelpFormatter(HelpFormatter.Builder) - Constructor for class org.apache.commons.cli.help.HelpFormatter
Constructs the Help formatter.
HelpFormatter.Builder - Class in org.apache.commons.cli.help
A builder for the HelpFormatter.
HelpFormatter.Builder - Class in org.apache.commons.cli
Deprecated.
HelpFormatter.OptionComparator - Class in org.apache.commons.cli
Deprecated.
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.
HEX_RADIX - Static variable in class org.apache.commons.cli.TypeHandler
Value of hex conversion of strings.

I

IGNORE - Enum constant in enum org.apache.commons.cli.DefaultParser.NonOptionAction
Parsing continues and current token is ignored.
indent - Variable in class org.apache.commons.cli.help.TextStyle.Builder
The subsequent line indentation.
indent - Variable in class org.apache.commons.cli.help.TextStyle
The size of the indent on the second and any subsequent lines of text.
indexOfEqual(String) - Static method in class org.apache.commons.cli.DefaultParser
 
indexOfNonWhitespace(CharSequence, int) - Static method in class org.apache.commons.cli.help.Util
Finds the index of the first non whitespace character.
indexOfWrap(CharSequence, int, int) - Static method in class org.apache.commons.cli.help.TextHelpAppendable
Finds the next text wrap position after startPos for the text in text with the column width width.
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
Tests if the token is a valid argument.
isDeprecated() - Method in class org.apache.commons.cli.Option
Tests whether this Option is deprecated.
isEmpty(CharSequence) - Static method in class org.apache.commons.cli.help.Util
Tests whether the given string is null or empty.
isEmpty(Object[]) - Static method in class org.apache.commons.cli.Util
Tests whether the given array is null or empty.
isEmpty(String) - Static method in class org.apache.commons.cli.Util
Tests whether the given string is null or empty.
isForRemoval() - Method in class org.apache.commons.cli.DeprecatedAttributes
Tests whether this option is subject to removal in a future version.
isJavaProperty(String) - Method in class org.apache.commons.cli.DefaultParser
Tests if the specified token is a Java-like property (-Dkey=value).
isLongOption(String) - Method in class org.apache.commons.cli.DefaultParser
Tests if the token looks like a long option.
isNegativeNumber(String) - Method in class org.apache.commons.cli.DefaultParser
Tests if the token is a negative number.
isOption(String) - Method in class org.apache.commons.cli.DefaultParser
Tests if the token looks like an option.
isRequired() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the required flag from the enclosed Option.
isRequired() - Method in class org.apache.commons.cli.Option
Tests whether this Option is required.
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
Tests 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.
isScalable() - Method in class org.apache.commons.cli.help.TextStyle.Builder
Specifies if the column can be made wider or to narrower width to fit constraints of the HelpAppendable and formatting.
isScalable() - Method in class org.apache.commons.cli.help.TextStyle
Specifies if the column can be made wider or to narrower width to fit constraints of the HelpAppendable and formatting.
isSelected() - Method in class org.apache.commons.cli.OptionGroup
Tests whether an option is selected.
isShortOption(String) - Method in class org.apache.commons.cli.DefaultParser
Tests 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.
isValuesEmpty() - Method in class org.apache.commons.cli.Option
Tests whether this Option has any values.
isWhitespace(char) - Static method in class org.apache.commons.cli.help.Util
Works around https://bugs.java.com/bugdatabase/view_bug?bug_id=8341522 Affected Version: 8, 11, 17, 21, 24.
iterator() - Method in class org.apache.commons.cli.CommandLine
Returns an iterator over the Option members of CommandLine.

L

LEFT - Enum constant in enum org.apache.commons.cli.help.TextStyle.Alignment
Left justifies the text.
leftPad - Variable in class org.apache.commons.cli.help.TextStyle.Builder
The left padding.
leftPad - Variable in class org.apache.commons.cli.help.TextStyle
The size of the left pad.
LF - Static variable in class org.apache.commons.cli.Char
Line feed.
longOpt(String) - Method in class org.apache.commons.cli.Option.Builder
Sets the long name of the Option.
longOption - Variable in class org.apache.commons.cli.Option.Builder
The long representation of the option.
longOption - Variable in class org.apache.commons.cli.Option
The long representation of the option.
longOption - Static variable in class org.apache.commons.cli.OptionBuilder
Deprecated.
Long option.
longOptPrefix - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The long option prefix
longOptPrefix - Variable in class org.apache.commons.cli.help.OptionFormatter
The prefix for the long option text.
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
Deprecated.
The separator displayed between the long option and its value.
ltrim(String) - Static method in class org.apache.commons.cli.help.Util
Removes the leading whitespace from the specified String.

M

makeColumnQueue(CharSequence, TextStyle) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Creates a queue comprising strings extracted from columnData where the alignment and length are determined by the style.
makeColumnQueues(List<String>, List<TextStyle>) - Method in class org.apache.commons.cli.help.TextHelpAppendable
For each column in the columnData apply the associated TextStyle and generated a queue of strings that are the maximum size of the column + the left pad.
matchingOptions - Variable in exception class org.apache.commons.cli.AmbiguousOptionException
The list of options matching the partial name specified
maxWidth - Variable in class org.apache.commons.cli.help.TextStyle.Builder
The maximum width.
maxWidth - Variable in class org.apache.commons.cli.help.TextStyle
The maximum size of the text.
minWidth - Variable in class org.apache.commons.cli.help.TextStyle.Builder
The minimum width.
minWidth - Variable in class org.apache.commons.cli.help.TextStyle
The minimum size of the text.
MissingArgumentException - Exception Class in org.apache.commons.cli
Thrown when an option requiring an argument is not provided with an argument.
MissingArgumentException(String) - Constructor for exception class org.apache.commons.cli.MissingArgumentException
Constructs a new MissingArgumentException with the specified detail message.
MissingArgumentException(Option) - Constructor for exception class org.apache.commons.cli.MissingArgumentException
Constructs a new MissingArgumentException with the specified detail message.
MissingOptionException - Exception Class in org.apache.commons.cli
Thrown when a required option has not been provided.
MissingOptionException(String) - Constructor for exception class org.apache.commons.cli.MissingOptionException
Constructs a new MissingSelectedException with the specified detail message.
MissingOptionException(List) - Constructor for exception class org.apache.commons.cli.MissingOptionException
Constructs a new MissingSelectedException with the specified list of missing options.
missingOptions - Variable in exception class org.apache.commons.cli.MissingOptionException
The list of missing options and groups

N

NO_DEPRECATED_FORMAT - Static variable in class org.apache.commons.cli.help.OptionFormatter
A function to display a deprecated option with the "[Deprecated]" prefix.
nonOptionAction - Variable in class org.apache.commons.cli.DefaultParser
Action to happen when "non option" token is discovered.
NonOptionAction() - Constructor for enum org.apache.commons.cli.DefaultParser.NonOptionAction
 
NOT_FOUND - Static variable in class org.apache.commons.cli.help.Util
A special value for index not found.
NUMBER - Static variable in interface org.apache.commons.cli.Converter
Number converter.
NUMBER_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
Number class
numberOfArgs(int) - Method in class org.apache.commons.cli.Option.Builder
Sets the number of argument values the Option can take.

O

OBJECT - Static variable in interface org.apache.commons.cli.Converter
Converts a class name to an instance of the class.
OBJECT_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
Object class
openFile(String) - Static method in class org.apache.commons.cli.TypeHandler
optArgSeparator - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The separator between the opt and/or longOpt and the argument name
optArgSeparator - Variable in class org.apache.commons.cli.help.OptionFormatter
the separator between the opt and/or longOpt and the argument name.
option - Variable in exception class org.apache.commons.cli.AlreadySelectedException
The option that triggered the exception.
option - Variable in class org.apache.commons.cli.help.OptionFormatter
The Option being formatted.
option - Variable in exception class org.apache.commons.cli.MissingArgumentException
The option requiring additional arguments
option - Variable in class org.apache.commons.cli.Option.Builder
The name of the option.
option - Variable in class org.apache.commons.cli.Option
The name of the option.
option - Variable in exception class org.apache.commons.cli.UnrecognizedOptionException
The unrecognized option.
option(String) - Method in class org.apache.commons.cli.Option.Builder
Sets the name of the 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
Builds 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.
optionalDelimiters - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The delimiters surrounding optional Option instances.
optionalDelimiters - Variable in class org.apache.commons.cli.help.OptionFormatter
The delimiters for optional Options.
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
Deprecated.
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
Deprecated.
 
optionFormatBuilder - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
The OptionFormatter.Builder to use to format options in the table.
optionFormatBuilder - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The OptionFormatter.Builder used to display options within the help page.
OptionFormatter - Class in org.apache.commons.cli.help
The definition of how to display Option attributes.
OptionFormatter(Option, OptionFormatter.Builder) - Constructor for class org.apache.commons.cli.help.OptionFormatter
An OptionFormatter applies formatting options to various Option attributes for textual display.
OptionFormatter.Builder - Class in org.apache.commons.cli.help
Builds instances of OptionFormatter.
optionGroup - Variable in exception class org.apache.commons.cli.AlreadySelectedException
The option group selected.
OptionGroup - Class in org.apache.commons.cli
A group of mutually exclusive options.
OptionGroup() - Constructor for class org.apache.commons.cli.OptionGroup
Constructs a new instance.
optionGroups - Variable in class org.apache.commons.cli.Options
A map of the option groups
optionGroupSeparator - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
The string to separate option groups.
optionGroupSeparator - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The separator between OptionGroup components.
optionMap - Variable in class org.apache.commons.cli.OptionGroup
Maps options where keys are option name and values are the options.
options - Variable in class org.apache.commons.cli.CommandLine.Builder
The processed 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
Constructs new instance.
OptionValidator - Class in org.apache.commons.cli
Validates an Option string.
OptionValidator() - Constructor for class org.apache.commons.cli.OptionValidator
 
optPrefix - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The option prefix
optPrefix - Variable in class org.apache.commons.cli.help.OptionFormatter
The prefix for the short option text.
optSeparator - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
The separator between long and short options
optSeparator - Variable in class org.apache.commons.cli.help.OptionFormatter
The separator between the options.
org.apache.commons.cli - package org.apache.commons.cli
Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface.
org.apache.commons.cli.help - package org.apache.commons.cli.help
The help production system.
output - Variable in class org.apache.commons.cli.help.FilterHelpAppendable
The underlying appendable to be filtered.

P

pad(boolean, CharSequence) - Method in class org.apache.commons.cli.help.TextStyle
Pads a string to the maximum width or optionally to the maximum width - indent.
parse(Options, String[]) - Method in interface org.apache.commons.cli.CommandLineParser
Parses 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 specified Options.
parse(Options, String[], boolean) - Method in interface org.apache.commons.cli.CommandLineParser
Parses 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 specified Options.
parse(Options, String[], Properties) - Method in class org.apache.commons.cli.DefaultParser
Parses the arguments according to the specified options and properties.
parse(Options, String[], Properties) - Method in class org.apache.commons.cli.Parser
Deprecated.
Parses the arguments according to the specified options and properties.
parse(Options, String[], Properties, boolean) - Method in class org.apache.commons.cli.DefaultParser
Parses the arguments according to the specified options and properties.
parse(Options, String[], Properties, boolean) - Method in class org.apache.commons.cli.Parser
Deprecated.
Parses the arguments according to the specified options and properties.
parse(Options, Properties, DefaultParser.NonOptionAction, String...) - Method in class org.apache.commons.cli.DefaultParser
Parses the arguments according to the specified options and properties.
ParseException - Exception Class in org.apache.commons.cli
Base for Exceptions thrown during parsing of a command-line.
ParseException(String) - Constructor for exception class org.apache.commons.cli.ParseException
Constructs a new ParseException with the specified detail message.
ParseException(Throwable) - Constructor for exception class org.apache.commons.cli.ParseException
Constructs a new ParseException wrapping the specified exception.
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
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.
Constructs a new instance.
PATH - Static variable in interface org.apache.commons.cli.Converter
Path converter.
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
Deprecated.
Will be private or class will be final.
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.
Constructs a new instance.
printHelp(int, String, String, Options, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints 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
Deprecated.
Prints 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
Deprecated.
Prints 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
Deprecated.
Prints the help for options with the specified command line syntax.
printHelp(String, String, Iterable<Option>, String, boolean) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Prints the help for Options with the specified command line syntax.
printHelp(String, String, Options, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the help for options with the specified command line syntax.
printHelp(String, String, Options, String, boolean) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Prints the help for a collection of Options with the specified command line syntax.
printHelp(String, String, Options, String, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the help for options with the specified command line syntax.
printHelp(String, Options) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the help for options with the specified command line syntax.
printHelp(String, Options, boolean) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the help for options with the specified command line syntax.
printOptions(PrintWriter, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the help for the specified Options to the specified writer, using the specified width, left padding and description padding.
printOptions(Iterable<Option>) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Prints the option table for a collection of Option objects to the HelpAppendable.
printOptions(TableDefinition) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
printOptions(Options) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Prints the option table for the specified Options to the HelpAppendable.
printQueue(Queue<String>) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Prints a queue of text.
printStream - Variable in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
The output PrintWriter, defaults to wrapping System.out.
printUsage(PrintWriter, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the cmdLineSyntax to the specified writer, using the specified width.
printUsage(PrintWriter, int, String, Options) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the usage statement for the specified application.
printWrapped(PrintWriter, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the specified text to the specified PrintWriter.
printWrapped(PrintWriter, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Prints the specified text to the specified PrintWriter.
printWrapped(String) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Prints wrapped text using the TextHelpAppendable output style.
printWrapped(String, TextStyle) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Prints wrapped text.
printWriter - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Where to print help.
processArgs(Option, ListIterator<String>) - Method in class org.apache.commons.cli.Parser
Deprecated.
Processes the argument values for the specified Option opt using the values retrieved from the specified iterator iter.
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.
Processes the Option specified by arg using the values retrieved from the specified iterator iter.
processOptionToken(String, boolean) - Method in class org.apache.commons.cli.PosixParser
Deprecated.
If an Option exists for token 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.
processPropertiesFromValues(Properties, List<String>) - Method in class org.apache.commons.cli.CommandLine
Parses a list of values as properties.
processValue(String) - Method in class org.apache.commons.cli.Option
Processes the value.
putDefaultMap(Map<Class<?>, Converter<?, ? extends Throwable>>) - Static method in class org.apache.commons.cli.TypeHandler
 

R

renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Renders the specified Options and return the rendered Options in a StringBuffer.
renderWrappedText(StringBuffer, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Renders the specified text and return the rendered Options in a StringBuffer.
renderWrappedTextBlock(A, int, int, String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Renders the specified text width a maximum width.
repeat(int, char) - Static method in class org.apache.commons.cli.help.Util
Constructs a string of specified length filled with the specified char.
repeatSpace(int) - Static method in class org.apache.commons.cli.help.Util
Creates a String of padding of length len.
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.
Required test.
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 required.
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
Tests whether 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.
resize(int, double) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Resizes an original width based on the fractional size it should be.
resize(TextStyle.Builder, double) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Resizes a TextStyle builder based on the fractional size.
resolveOption(String) - Method in class org.apache.commons.cli.CommandLine
Retrieves the option object given the long or short option as a String
RIGHT - Enum constant in enum org.apache.commons.cli.help.TextStyle.Alignment
Right justifies the text.
rows() - Method in interface org.apache.commons.cli.help.TableDefinition
Gets the collection of rows.
rtrim(String) - Static method in class org.apache.commons.cli.help.Util
Removes the trailing whitespace from the specified String.
rtrim(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Removes the trailing whitespace from the specified String.

S

scalable - Variable in class org.apache.commons.cli.help.TextStyle.Builder
The scalable flag.
scalable - Variable in class org.apache.commons.cli.help.TextStyle
The scaling allowed for the block.
search(char[], char) - Static method in class org.apache.commons.cli.OptionValidator
Checks the char array for a matching char.
selected - Variable in class org.apache.commons.cli.OptionGroup
The name of the selected option.
serialVersionUID - Static variable in exception class org.apache.commons.cli.AlreadySelectedException
This exception serialVersionUID.
serialVersionUID - Static variable in exception class 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
Deprecated.
The serial version UID.
serialVersionUID - Static variable in exception class org.apache.commons.cli.MissingArgumentException
This exception serialVersionUID.
serialVersionUID - Static variable in exception class 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 class org.apache.commons.cli.ParseException
This exception serialVersionUID.
serialVersionUID - Static variable in exception class org.apache.commons.cli.UnrecognizedOptionException
This exception serialVersionUID.
setAlignment(TextStyle.Alignment) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets the alignment.
setAllowPartialMatching(boolean) - Method in class org.apache.commons.cli.DefaultParser.Builder
Sets if partial matching of long options is supported.
setArgName(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
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.
setArgumentNameDelimiters(String, String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Specifies the starting and ending argument name delimiters for Option instances.
setComparator(Comparator<Option>) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Sets the comparator to use for sorting options.
setConverter(Converter<?, ?>) - Method in class org.apache.commons.cli.Option
Sets the value to type converter.
setDefaultArgName(String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Sets the default argument name.
setDeprecatedFormatFunction(Function<Option, String>) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Specifies the function to construct the deprecated massage for the Option.
setDeprecatedHandler(Consumer<Option>) - Method in class org.apache.commons.cli.CommandLine.Builder
Sets the deprecated option handler.
setDeprecatedHandler(Consumer<Option>) - Method in class org.apache.commons.cli.DefaultParser.Builder
Sets the deprecated option handler.
setDescPadding(int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the 'descPadding'.
setDescription(String) - Method in class org.apache.commons.cli.DeprecatedAttributes.Builder
Sets the description.
setDescription(String) - Method in class org.apache.commons.cli.Option
Sets the self-documenting description of this Option.
setForRemoval(boolean) - Method in class org.apache.commons.cli.DeprecatedAttributes.Builder
Sets whether this option is subject to removal in a future version.
setHelpAppendable(HelpAppendable) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Sets the HelpAppendable.
setIndent(int) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Sets the indent for the output.
setIndent(int) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets the indent value.
setLeftPad(int) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Sets the left padding: the number of characters from the left edge to start output.
setLeftPad(int) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets the left padding.
setLeftPadding(int) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
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.help.OptionFormatter.Builder
Sets the long option prefix.
setLongOptPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the 'longOptPrefix'.
setLongOptSeparator(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the separator displayed between a long option and its value.
setMaxWidth(int) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Sets the maximum width for the output.
setMaxWidth(int) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets the currently specified minimum width.
setMinWidth(int) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets the currently specified minimum width.
setNewLine(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the 'newLine'.
setOptArgSeparator(String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Sets the separator displayed between a options and the argument name.
setOptionalArg(boolean) - Method in class org.apache.commons.cli.Option
Sets whether this Option can have an optional argument.
setOptionalDelimiters(String, String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Specifies the starting and ending delimiters for optional Option instances.
setOptionComparator(Comparator<Option>) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the comparator used to sort the options when they output in help text.
setOptionFormatBuilder(OptionFormatter.Builder) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
setOptionGroupSeparator(String) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
Sets the OptionGroup separator.
setOptions(Options) - Method in class org.apache.commons.cli.Parser
Deprecated.
Sets the options.
setOptPrefix(String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Specifies the short option prefix.
setOptPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the 'optPrefix'.
setOptSeparator(String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Sets the separator displayed between a long option and short options.
setPrintWriter(PrintWriter) - Method in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
Sets the output PrintWriter, defaults to wrapping System.out.
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
Sets whether this group is required.
setScalable(boolean) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets whether the column can be made wider or to narrower width to fit constraints of the HelpAppendable and formatting.
setSelected(Option) - Method in class org.apache.commons.cli.OptionGroup
Sets the selected option of this group to name.
setShowDeprecated(boolean) - Method in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
Sets whether to show deprecated options.
setShowDeprecated(Function<Option, String>) - Method in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
Sets whether to show deprecated options.
setShowSince(boolean) - Method in class org.apache.commons.cli.help.HelpFormatter.Builder
Sets the showSince flag.
setShowSince(boolean) - Method in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
Sets whether to show the date the option was first added.
setSince(String) - Method in class org.apache.commons.cli.DeprecatedAttributes.Builder
Sets the version in which the option became deprecated.
setStripLeadingAndTrailingQuotes(Boolean) - Method in class org.apache.commons.cli.DefaultParser.Builder
Sets if balanced leading and trailing double quotes should be stripped from option arguments.
setSyntaxFormatFunction(BiFunction<OptionFormatter, Boolean, String>) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
Specifies the function to convert an OptionFormatter into the syntax format for the option.
setSyntaxPrefix(String) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Sets the syntax prefix.
setSyntaxPrefix(String) - Method in class org.apache.commons.cli.HelpFormatter
Deprecated.
Sets the 'syntaxPrefix'.
setTextStyle(TextStyle) - Method in class org.apache.commons.cli.help.TextStyle.Builder
Sets all properties from the given text style.
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
Deprecated.
Sets the 'width'.
shortOpts - Variable in class org.apache.commons.cli.Options
A map of the options with the character key
showSince - Variable in class org.apache.commons.cli.help.HelpFormatter.Builder
If true show the "Since" column, otherwise ignore it.
showSince - Variable in class org.apache.commons.cli.help.HelpFormatter
If true show the "Since" column, otherwise ignore it.
showSince - Variable in class org.apache.commons.cli.HelpFormatter.Builder
Deprecated.
The flag to determine if the since values should be dispalyed
showSince - Variable in class org.apache.commons.cli.HelpFormatter
Deprecated.
Flag to determine if since field should be displayed
SIMPLE_DEPRECATED_FORMAT - Static variable in class org.apache.commons.cli.help.OptionFormatter
A function to display a deprecated option with the "[Deprecated]" prefix.
since - Variable in class org.apache.commons.cli.DeprecatedAttributes.Builder
The version in which the option became deprecated.
since - Variable in class org.apache.commons.cli.DeprecatedAttributes
The version label for removal.
since - Variable in class org.apache.commons.cli.Option.Builder
Specifies the version when this option was added.
since - Variable in class org.apache.commons.cli.Option
Specifies the version when this option was added.
since(String) - Method in class org.apache.commons.cli.Option.Builder
Sets the version number when this option was first defined."
SKIP - Enum constant in enum org.apache.commons.cli.DefaultParser.NonOptionAction
Parsing continues and current token is added to command line arguments.
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.
sort(Iterable<Option>) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Creates a new list of options ordered by the comparator.
sort(Options) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Creates a new list of options ordered by the comparator.
SP - Static variable in class org.apache.commons.cli.Char
Space.
STOP - Enum constant in enum org.apache.commons.cli.DefaultParser.NonOptionAction
Parsing will stop and remaining tokens are added to command line arguments.
stopAtNonOption - Variable in class org.apache.commons.cli.DefaultParser
Deprecated.
Use DefaultParser.nonOptionAction instead. This field is unused, and left for binary compatibility reasons.
STRING_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
String class
stripLeadingAndTrailingQuotes - Variable in class org.apache.commons.cli.DefaultParser.Builder
Flag indicating if balanced leading and trailing double quotes should be stripped from option arguments.
stripLeadingAndTrailingQuotes - Variable in class org.apache.commons.cli.DefaultParser
Flag indicating if balanced leading and trailing double quotes should be stripped from option arguments.
stripLeadingAndTrailingQuotes(String) - Static method in class org.apache.commons.cli.Util
Removes the leading and trailing quotes from str.
stripLeadingAndTrailingQuotesDefaultOff(String) - Method in class org.apache.commons.cli.DefaultParser
Strips balanced leading and trailing quotes if the stripLeadingAndTrailingQuotes is set If stripLeadingAndTrailingQuotes is null, then do not strip
stripLeadingAndTrailingQuotesDefaultOn(String) - Method in class org.apache.commons.cli.DefaultParser
Strips balanced leading and trailing quotes if the stripLeadingAndTrailingQuotes is set If stripLeadingAndTrailingQuotes is null, then do not strip
stripLeadingHyphens(String) - Static method in class org.apache.commons.cli.Util
Removes the hyphens from the beginning of str and return the new String.
syntaxFormatFunction - Variable in class org.apache.commons.cli.help.OptionFormatter.Builder
A function to convert the OptionFormatter into an entry in the syntax description.
syntaxFormatFunction - Variable in class org.apache.commons.cli.help.OptionFormatter
The method to convert an Option formatter into a syntax notation.
syntaxPrefix - Variable in class org.apache.commons.cli.help.AbstractHelpFormatter
The phrase printed before the syntax line.
systemOut() - Static method in class org.apache.commons.cli.help.TextHelpAppendable
Creates a new TextHelpAppendable on System.out.

T

TAB - Static variable in class org.apache.commons.cli.Char
Tab.
TableDefinition - Interface in org.apache.commons.cli.help
The definition of a table to display.
TextHelpAppendable - Class in org.apache.commons.cli.help
Writes text format output.
TextHelpAppendable(Appendable) - Constructor for class org.apache.commons.cli.help.TextHelpAppendable
Constructs an appendable filter built on top of the specified underlying appendable.
TextStyle - Class in org.apache.commons.cli.help
The definition for styling recommendations blocks of text.
TextStyle(TextStyle.Builder) - Constructor for class org.apache.commons.cli.help.TextStyle
Constructs a new instance.
TextStyle.Alignment - Enum in org.apache.commons.cli.help
The alignment possibilities.
TextStyle.Builder - Class in org.apache.commons.cli.help
The builder for the TextStyle.
textStyleBuilder - Variable in class org.apache.commons.cli.help.TextHelpAppendable
Defines the TextStyle for paragraph, and associated output formats.
THROW - Enum constant in enum org.apache.commons.cli.DefaultParser.NonOptionAction
Parsing will abort and exception is thrown.
toArgName(String) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Formats the argName as an argument a defined in the enclosed OptionFormatter.Builder.
toArgName(String) - Method in class org.apache.commons.cli.help.OptionFormatter.Builder
A helper method to format any string as an argument name based on this builder.
toDeprecatedString() - Method in class org.apache.commons.cli.Option
 
toEmpty(String) - Method in class org.apache.commons.cli.DeprecatedAttributes
 
tokens - Variable in class org.apache.commons.cli.PosixParser
Deprecated.
Holder for flattened tokens.
toOptional(String) - Method in class org.apache.commons.cli.help.OptionFormatter
Wraps the provided text in the optional delimiters.
toString() - Method in class org.apache.commons.cli.DeprecatedAttributes
 
toString() - Method in class org.apache.commons.cli.help.TextStyle
 
toString() - Method in class org.apache.commons.cli.Option
Creates a String 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.
toSyntaxOption() - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the syntax format for this option.
toSyntaxOption(boolean) - Method in class org.apache.commons.cli.help.OptionFormatter
Gets the syntax format for this option.
toSyntaxOptions(Iterable<Option>) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Return the string representation of the options as used in the syntax display.
toSyntaxOptions(Iterable<Option>, Function<Option, OptionGroup>) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Return the string representation of the options as used in the syntax display.
toSyntaxOptions(OptionGroup) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Return the string representation of the options as used in the syntax display.
toSyntaxOptions(Options) - Method in class org.apache.commons.cli.help.AbstractHelpFormatter
Return the string representation of the options as used in the syntax display.
toType(Class<?>) - Static method in class org.apache.commons.cli.Option.Builder
Returns the input Class or the default type (String) if null.
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
TypeHandler will handle the pluggable conversion and verification of Option types.
TypeHandler() - Constructor for class org.apache.commons.cli.TypeHandler
Constructs a default initialized instance.
TypeHandler(Map<Class<?>, Converter<?, ? extends Throwable>>) - Constructor for class org.apache.commons.cli.TypeHandler
Constructs a default initialized instance.

U

UNINITIALIZED - Static variable in class org.apache.commons.cli.Option
Specifies the number of argument values has not been specified.
UNLIMITED_VALUES - Static variable in class org.apache.commons.cli.Option
Specifies the number of argument values is infinite.
UnrecognizedOptionException - Exception Class in org.apache.commons.cli
Thrown during parsing signaling an unrecognized option.
UnrecognizedOptionException(String) - Constructor for exception class org.apache.commons.cli.UnrecognizedOptionException
Constructs a new UnrecognizedArgumentException with the specified detail message.
UnrecognizedOptionException(String, String) - Constructor for exception class org.apache.commons.cli.UnrecognizedOptionException
Constructs a new UnrecognizedArgumentException with the specified option and detail message.
UNSET_MAX_WIDTH - Static variable in class org.apache.commons.cli.help.TextStyle
The unset value for maxWidth: 2147483647.
unsupported() - Static method in class org.apache.commons.cli.PatternOptionBuilder
 
UNSUPPORTED - Static variable in class org.apache.commons.cli.PatternOptionBuilder
The converter to use for Unimplemented data types
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 - Static variable in interface org.apache.commons.cli.Converter
Creates a URL.
URL_VALUE - Static variable in class org.apache.commons.cli.PatternOptionBuilder
URL class
Util - Class in org.apache.commons.cli.help
Contains useful helper methods for classes within this package.
Util - Class in org.apache.commons.cli
Contains useful helper methods for classes within this package.
Util() - Constructor for class org.apache.commons.cli.help.Util
 
Util() - Constructor for class org.apache.commons.cli.Util
 

V

validate(String) - Static method in class org.apache.commons.cli.OptionValidator
Validates whether opt is a permissible Option shortOpt.
valueOf(String) - Static method in enum org.apache.commons.cli.DefaultParser.NonOptionAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.commons.cli.help.TextStyle.Alignment
Returns the enum constant of this type with the specified name.
values - Variable in class org.apache.commons.cli.Option
The list of argument values.
values() - Static method in enum org.apache.commons.cli.DefaultParser.NonOptionAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.commons.cli.help.TextStyle.Alignment
Returns an array containing the constants of this enum type, in the order they are declared.
valueSeparator - Variable in class org.apache.commons.cli.Option.Builder
The character that is the value separator.
valueSeparator - Variable in class org.apache.commons.cli.Option
The character that is the value separator.
valueSeparator - 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.
wrap(Throwable) - Static method in exception class org.apache.commons.cli.ParseException
Converts any exception except UnsupportedOperationException to a ParseException.
writeColumnQueues(List<Queue<String>>, List<TextStyle>) - Method in class org.apache.commons.cli.help.TextHelpAppendable
Writes one line from each of the columnQueues until all the queues are exhausted.
A B C D E F G H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form