Uses of Class
org.apache.commons.cli.Option

Packages that use Option

Package	Description
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	The help production system.

Uses of Option in org.apache.commons.cli

Fields in org.apache.commons.cli declared as Option

Modifier and Type	Field	Description
protected Option	DefaultParser.currentOption	The last option parsed.
private Option	PosixParser.currentOption	Deprecated. Holder for the current option
(package private) static Option[]	Option.EMPTY_ARRAY	Empty array.
private Option	AlreadySelectedException.option	The option that triggered the exception.
private Option	MissingArgumentException.option	The option requiring additional arguments

Fields in org.apache.commons.cli with type parameters of type Option

Modifier and Type	Field	Description
private static java.util.function.Function<Option,java.lang.String>	HelpFormatter.Builder.DEFAULT_DEPRECATED_FORMAT	A function to convert a description (not null) and a deprecated Option (not null) to help description
(package private) static java.util.function.Consumer<Option>	CommandLine.Builder.DEPRECATED_HANDLER	Prints an Option to System.out.
private java.util.function.Function<Option,java.lang.String>	HelpFormatter.Builder.deprecatedFormatFunction	Formatter for deprecated options.
private java.util.function.Function<Option,java.lang.String>	HelpFormatter.deprecatedFormatFunction	Deprecated. Function to format the description for a deprecated option.
private java.util.function.Consumer<Option>	CommandLine.Builder.deprecatedHandler	Deprecated Option handler.
private java.util.function.Consumer<Option>	CommandLine.deprecatedHandler	The deprecated option handler.
private java.util.function.Consumer<Option>	DefaultParser.Builder.deprecatedHandler	The deprecated option handler.
private java.util.function.Consumer<Option>	DefaultParser.deprecatedHandler	The deprecated option handler.
private java.util.Map<java.lang.String,Option>	Options.longOpts	A map of the options with the long key
protected java.util.Comparator<Option>	HelpFormatter.optionComparator	Deprecated. Comparator used to sort the options when they output in help text Defaults to case-insensitive alphabetical sorting by option key
private java.util.Map<java.lang.String,Option>	OptionGroup.optionMap	Maps options where keys are option name and values are the options.
private java.util.List<Option>	CommandLine.Builder.options	The processed options
private java.util.List<Option>	CommandLine.options	The processed options
private java.util.Map<java.lang.String,Option>	Options.shortOpts	A map of the options with the character key

Methods in org.apache.commons.cli that return Option

Modifier and Type	Method	Description
Option	Option.Builder.build()	Deprecated. Use Option.Builder.get().
static Option	OptionBuilder.create()	Deprecated. Creates an Option using the current settings.
static Option	OptionBuilder.create(char opt)	Deprecated. Creates an Option using the current settings and with the specified Option char.
static Option	OptionBuilder.create(java.lang.String opt)	Deprecated. Creates an Option using the current settings and with the specified Option char.
Option	Option.Builder.get()	Constructs an Option with the values declared by this Option.Builder.
Option	AlreadySelectedException.getOption()	Gets the option that was added to the group and triggered the exception.
Option	MissingArgumentException.getOption()	Gets the option requiring an argument that wasn't provided on the command line.
Option	Options.getOption(java.lang.String opt)	Gets the Option matching the long or short name specified.
Option[]	CommandLine.getOptions()	Gets an array of the processed Options.
private Option	CommandLine.resolveOption(java.lang.String optionName)	Retrieves the option object given the long or short option as a String

Methods in org.apache.commons.cli that return types with arguments of type Option

Modifier and Type	Method	Description
java.util.Comparator<Option>	HelpFormatter.getOptionComparator()	Deprecated. Comparator used to sort the options when they output in help text.
java.util.Collection<Option>	OptionGroup.getOptions()	Gets the options in this group as a Collection.
java.util.Collection<Option>	Options.getOptions()	Gets a read-only list of options in this set.
(package private) java.util.List<Option>	Options.helpOptions()	Returns the Options for use by the HelpFormatter.
java.util.Iterator<Option>	CommandLine.iterator()	Returns an iterator over the Option members of CommandLine.

Methods in org.apache.commons.cli with parameters of type Option

Modifier and Type	Method	Description
protected void	CommandLine.addOption(Option option)	Adds an option to the command line.
CommandLine.Builder	CommandLine.Builder.addOption(Option option)	Adds an option to the command line.
OptionGroup	OptionGroup.addOption(Option option)	Adds the given Option to this group.
Options	Options.addOption(Option opt)	Adds an option instance.
private void	HelpFormatter.appendOption(java.lang.StringBuilder buff, Option option, boolean required)	Deprecated. Appends the usage clause for an Option to a StringBuffer.
int	HelpFormatter.OptionComparator.compare(Option opt1, Option opt2)	Compares its two arguments for order.
static java.lang.String	HelpFormatter.getDescription(Option option)	Deprecated. Gets the option description or an empty string if the description is null.
int	CommandLine.getOptionCount(Option option)	Gets the number of times this option appears in the command line.
OptionGroup	Options.getOptionGroup(Option option)	Gets the OptionGroup the opt belongs to.
java.util.Properties	CommandLine.getOptionProperties(Option option)	Gets the map of values associated to the option.
java.lang.String	CommandLine.getOptionValue(Option option)	Gets the first argument, if any, of this option.
java.lang.String	CommandLine.getOptionValue(Option option, java.lang.String defaultValue)	Gets the first argument, if any, of an option.
java.lang.String	CommandLine.getOptionValue(Option option, java.util.function.Supplier<java.lang.String> defaultValue)	Gets the first argument, if any, of an option.
java.lang.String[]	CommandLine.getOptionValues(Option option)	Gets the array of values, if any, of an option.
<T> T	CommandLine.getParsedOptionValue(Option option)	Gets a version of this Option converted to a particular type.
<T> T	CommandLine.getParsedOptionValue(Option option, java.util.function.Supplier<T> defaultValue)	Gets a version of this Option converted to a particular type.
<T> T	CommandLine.getParsedOptionValue(Option option, T defaultValue)	Gets a version of this Option converted to a particular type.
<T> T[]	CommandLine.getParsedOptionValues(Option option)	Gets a version of this Option converted to an array of a particular type.
<T> T[]	CommandLine.getParsedOptionValues(Option option, java.util.function.Supplier<T[]> defaultValue)	Gets a version of this Option converted to an array of a particular type.
<T> T[]	CommandLine.getParsedOptionValues(Option option, T[] defaultValue)	Gets a version of this Option converted to an array of a particular type.
private void	CommandLine.handleDeprecated(Option option)	Handles deprecated options.
private void	DefaultParser.handleOption(Option option)
boolean	CommandLine.hasOption(Option option)	Tests to see if an option has been set.
void	Parser.processArgs(Option opt, java.util.ListIterator<java.lang.String> iter)	Deprecated. Processes the argument values for the specified Option opt using the values retrieved from the specified iterator iter.
void	OptionGroup.setSelected(Option option)	Sets the selected option of this group to name.
private void	DefaultParser.updateRequiredOptions(Option option)	Removes the option or its group from the list of expected elements.
private void	Parser.updateRequiredOptions(Option opt)	Deprecated. Removes the option or its group from the list of expected elements.

Method parameters in org.apache.commons.cli with type arguments of type Option

Modifier and Type	Method	Description
CommandLine.Builder	CommandLine.Builder.setDeprecatedHandler(java.util.function.Consumer<Option> deprecatedHandler)	Sets the deprecated option handler.
DefaultParser.Builder	DefaultParser.Builder.setDeprecatedHandler(java.util.function.Consumer<Option> deprecatedHandler)	Sets the deprecated option handler.
void	HelpFormatter.setOptionComparator(java.util.Comparator<Option> comparator)	Deprecated. Sets the comparator used to sort the options when they output in help text.
HelpFormatter.Builder	HelpFormatter.Builder.setShowDeprecated(java.util.function.Function<Option,java.lang.String> deprecatedFormatFunction)	Sets whether to show deprecated options.

Constructors in org.apache.commons.cli with parameters of type Option

Constructor	Description
AlreadySelectedException(java.lang.String message, OptionGroup optionGroup, Option option)
AlreadySelectedException(OptionGroup optionGroup, Option option)	Constructs a new AlreadySelectedException for the specified option group.
MissingArgumentException(Option option)	Constructs a new MissingArgumentException with the specified detail message.

Constructor parameters in org.apache.commons.cli with type arguments of type Option

Constructor	Description
CommandLine(java.util.List<java.lang.String> args, java.util.List<Option> options, java.util.function.Consumer<Option> deprecatedHandler)	Creates a command line.
DefaultParser(boolean allowPartialMatching, java.lang.Boolean stripLeadingAndTrailingQuotes, java.util.function.Consumer<Option> deprecatedHandler)	Creates a new DefaultParser instance with the specified partial matching and quote stripping policy.
HelpFormatter(java.util.function.Function<Option,java.lang.String> deprecatedFormatFunction, java.io.PrintWriter printWriter, boolean showSince)	Deprecated. Constructs a new instance.

Uses of Option in org.apache.commons.cli.help

Fields in org.apache.commons.cli.help declared as Option

Modifier and Type	Field	Description
private Option	OptionFormatter.option	The Option being formatted.

Fields in org.apache.commons.cli.help with type parameters of type Option

Modifier and Type	Field	Description
private java.util.Comparator<Option>	AbstractHelpFormatter.Builder.comparator	The comparator to sort lists of options
private java.util.Comparator<Option>	AbstractHelpFormatter.comparator	The comparator for sorting Option collections
static java.util.function.Function<Option,java.lang.String>	OptionFormatter.COMPLEX_DEPRECATED_FORMAT	A function to display a deprecated option with a "Deprecated" prefix that displays all deprecation information.
static java.util.Comparator<Option>	AbstractHelpFormatter.DEFAULT_COMPARATOR	The default comparator for Option implementations.
private java.util.function.Function<Option,java.lang.String>	OptionFormatter.Builder.deprecatedFormatFunction	The function to create the deprecated message for an option
private java.util.function.Function<Option,java.lang.String>	OptionFormatter.deprecatedFormatFunction	The function to display the deprecated option message.
static java.util.function.Function<Option,java.lang.String>	OptionFormatter.NO_DEPRECATED_FORMAT	A function to display a deprecated option with the "[Deprecated]" prefix.
static java.util.function.Function<Option,java.lang.String>	OptionFormatter.SIMPLE_DEPRECATED_FORMAT	A function to display a deprecated option with the "[Deprecated]" prefix.

Methods in org.apache.commons.cli.help that return types with arguments of type Option

Modifier and Type	Method	Description
protected java.util.Comparator<Option>	AbstractHelpFormatter.Builder.getComparator()	Gets the comparator to sort lists of options.
protected java.util.Comparator<Option>	AbstractHelpFormatter.getComparator()	Gets the comparator for sorting options.
java.util.List<Option>	AbstractHelpFormatter.sort(java.lang.Iterable<Option> options)	Creates a new list of options ordered by the comparator.
java.util.List<Option>	AbstractHelpFormatter.sort(Options options)	Creates a new list of options ordered by the comparator.

Methods in org.apache.commons.cli.help with parameters of type Option

Modifier and Type	Method	Description
OptionFormatter	OptionFormatter.Builder.build(Option option)	Build an OptionFormatter to format the specified option.
static OptionFormatter	OptionFormatter.from(Option option)	Construct the OptionFormatter from an Option using the default OptionFormatter.Builder.
OptionFormatter	AbstractHelpFormatter.getOptionFormatter(Option option)	Constructs an OptionFormatter for the specified Option.

Method parameters in org.apache.commons.cli.help with type arguments of type Option

Modifier and Type	Method	Description
protected abstract TableDefinition	AbstractHelpFormatter.getTableDefinition(java.lang.Iterable<Option> options)	Converts a collection of Options into a TableDefinition.
TableDefinition	HelpFormatter.getTableDefinition(java.lang.Iterable<Option> options)	Gets the table definition for the options.
void	AbstractHelpFormatter.printHelp(java.lang.String cmdLineSyntax, java.lang.String header, java.lang.Iterable<Option> options, java.lang.String footer, boolean autoUsage)	Prints the help for Options with the specified command line syntax.
void	AbstractHelpFormatter.printOptions(java.lang.Iterable<Option> options)	Prints the option table for a collection of Option objects to the HelpAppendable.
B	AbstractHelpFormatter.Builder.setComparator(java.util.Comparator<Option> comparator)	Sets the comparator to use for sorting options.
OptionFormatter.Builder	OptionFormatter.Builder.setDeprecatedFormatFunction(java.util.function.Function<Option,java.lang.String> deprecatedFormatFunction)	Specifies the function to construct the deprecated massage for the Option.
java.util.List<Option>	AbstractHelpFormatter.sort(java.lang.Iterable<Option> options)	Creates a new list of options ordered by the comparator.
java.lang.String	AbstractHelpFormatter.toSyntaxOptions(java.lang.Iterable<Option> options)	Return the string representation of the options as used in the syntax display.
protected java.lang.String	AbstractHelpFormatter.toSyntaxOptions(java.lang.Iterable<Option> options, java.util.function.Function<Option,OptionGroup> lookup)	Return the string representation of the options as used in the syntax display.
protected java.lang.String	AbstractHelpFormatter.toSyntaxOptions(java.lang.Iterable<Option> options, java.util.function.Function<Option,OptionGroup> lookup)	Return the string representation of the options as used in the syntax display.

Constructors in org.apache.commons.cli.help with parameters of type Option

Constructor	Description
OptionFormatter(Option option, OptionFormatter.Builder builder)	An OptionFormatter applies formatting options to various Option attributes for textual display.