Uses of Class
org.apache.commons.cli.Option
-
-
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 optionprivate Option
AlreadySelectedException. option
The option that triggered the exception.private Option
MissingArgumentException. option
The option requiring additional argumentsFields in org.apache.commons.cli with type parameters of type Option Modifier and Type Field Description private java.util.Map<java.lang.String,Option>
Options. longOpts
a map of the options with the long keyprotected java.util.Comparator<Option>
HelpFormatter. optionComparator
Comparator used to sort the options when they output in help text Defaults to case-insensitive alphabetical sorting by option keyprivate java.util.Map<java.lang.String,Option>
OptionGroup. optionMap
hold the optionsprivate java.util.List<Option>
CommandLine. options
the processed optionsprivate java.util.Map<java.lang.String,Option>
Options. shortOpts
a map of the options with the character keyMethods in org.apache.commons.cli that return Option Modifier and Type Method Description Option
Option.Builder. build()
Constructs an Option with the values declared by thisOption.Builder
.static Option
OptionBuilder. create()
Deprecated.Create an Option using the current settingsstatic Option
OptionBuilder. create(char opt)
Deprecated.Create an Option using the current settings and with the specified Optionchar
.static Option
OptionBuilder. create(java.lang.String opt)
Deprecated.Create an Option using the current settings and with the specified Optionchar
.(package private) Option
Options. getLongOption(java.lang.String opt)
Retrieve theOption
matching the long name specified.Option
AlreadySelectedException. getOption()
Returns the option that was added to the group and triggered the exception.Option
MissingArgumentException. getOption()
Return the option requiring an argument that wasn't provided on the command line.Option
Options. getOption(java.lang.String opt)
Retrieve theOption
matching the long or short name specified.Option[]
CommandLine. getOptions()
Returns an array of the processedOption
s.private Option
CommandLine. resolveOption(java.lang.String opt)
Retrieves the option object given the long or short option as a StringMethods in org.apache.commons.cli that return types with arguments of type Option Modifier and Type Method Description java.util.Comparator<Option>
HelpFormatter. getOptionComparator()
Comparator used to sort the options when they output in help text.java.util.Collection<Option>
OptionGroup. getOptions()
java.util.Collection<Option>
Options. getOptions()
Retrieve 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 opt)
Add an option to the command line.CommandLine.Builder
CommandLine.Builder. addOption(Option opt)
Add an option to the command line.OptionGroup
OptionGroup. addOption(Option option)
Add the specifiedOption
to this group.Options
Options. addOption(Option opt)
Adds an option instanceprivate void
HelpFormatter. appendOption(java.lang.StringBuffer buff, Option option, boolean required)
Appends the usage clause for an Option to a StringBuffer.int
HelpFormatter.OptionComparator. compare(Option opt1, Option opt2)
Compares its two arguments for order.OptionGroup
Options. getOptionGroup(Option opt)
Returns the OptionGroup theopt
belongs to.private void
DefaultParser. handleOption(Option option)
void
Parser. processArgs(Option opt, java.util.ListIterator<java.lang.String> iter)
Deprecated.Process the argument values for the specified Optionopt
using the values retrieved from the specified iteratoriter
.void
OptionGroup. setSelected(Option option)
Set the selected option of this group toname
.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 void
HelpFormatter. setOptionComparator(java.util.Comparator<Option> comparator)
Set the comparator used to sort the options when they output in help text.Constructors in org.apache.commons.cli with parameters of type Option Constructor Description AlreadySelectedException(OptionGroup group, Option option)
Construct a newAlreadySelectedException
for the specified option group.MissingArgumentException(Option option)
Construct a newMissingArgumentException
with the specified detail message.
-