Modifier and Type | Field and Description |
---|---|
protected Option |
DefaultParser.currentOption
The last option parsed.
|
Modifier and Type | Field and Description |
---|---|
protected Comparator<Option> |
HelpFormatter.optionComparator
Comparator used to sort the options when they output in help text
Defaults to case-insensitive alphabetical sorting by option key
|
Modifier and Type | Method and Description |
---|---|
Option |
Option.Builder.build()
Constructs an Option with the values declared by this
Option.Builder . |
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(String opt)
Deprecated.
Creates an Option using the current settings and with the specified Option
char . |
Option |
MissingArgumentException.getOption()
Return the option requiring an argument that wasn't provided on the command line.
|
Option |
AlreadySelectedException.getOption()
Gets the option that was added to the group and triggered the exception.
|
Option |
Options.getOption(String opt)
Gets the
Option matching the long or short name specified. |
Option[] |
CommandLine.getOptions()
Gets an array of the processed
Option s. |
Modifier and Type | Method and Description |
---|---|
Comparator<Option> |
HelpFormatter.getOptionComparator()
Comparator used to sort the options when they output in help text.
|
Collection<Option> |
Options.getOptions()
Gets a read-only list of options in this set
|
Collection<Option> |
OptionGroup.getOptions() |
Iterator<Option> |
CommandLine.iterator()
Returns an iterator over the Option members of CommandLine.
|
Modifier and Type | Method and Description |
---|---|
Options |
Options.addOption(Option opt)
Adds an option instance
|
OptionGroup |
OptionGroup.addOption(Option option)
Add the specified
Option to this group. |
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 |
Options.getOptionGroup(Option opt)
Gets the OptionGroup the
opt belongs to. |
Properties |
CommandLine.getOptionProperties(Option option)
Retrieve the map of values associated to the option.
|
String |
CommandLine.getOptionValue(Option option)
Retrieve the first argument, if any, of this option.
|
String |
CommandLine.getOptionValue(Option option,
String defaultValue)
Retrieve the first argument, if any, of an option.
|
String[] |
CommandLine.getOptionValues(Option option)
Retrieves the array of values, if any, of an option.
|
Object |
CommandLine.getParsedOptionValue(Option option)
Return a version of this
Option converted to a particular type. |
boolean |
CommandLine.hasOption(Option opt)
Tests to see if an option has been set.
|
void |
Parser.processArgs(Option opt,
ListIterator<String> iter)
Deprecated.
Process the argument values for the specified Option
opt using the values retrieved from the specified
iterator iter . |
void |
OptionGroup.setSelected(Option option)
Set the selected option of this group to
name . |
Modifier and Type | Method and Description |
---|---|
void |
HelpFormatter.setOptionComparator(Comparator<Option> comparator)
Set the comparator used to sort the options when they output in help text.
|
Constructor and Description |
---|
AlreadySelectedException(OptionGroup group,
Option option)
Constructs a new
AlreadySelectedException for the specified option group. |
MissingArgumentException(Option option)
Construct a new
MissingArgumentException with the specified detail message. |
Copyright © 2002–2020 The Apache Software Foundation. All rights reserved.