| Modifier and Type | Field | Description |
|---|---|---|
protected Option |
DefaultParser.currentOption |
The last option parsed.
|
| Modifier and Type | Field | Description |
|---|---|---|
protected 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 key
|
| Modifier and Type | Method | Description |
|---|---|---|
Option |
Option.Builder.build() |
Constructs an Option with the values declared by this
Option.Builder. |
static Option |
OptionBuilder.create() |
Deprecated.
Create an Option using the current settings
|
static Option |
OptionBuilder.create(char opt) |
Deprecated.
Create an Option using the current settings and with
the specified Option
char. |
static Option |
OptionBuilder.create(java.lang.String opt) |
Deprecated.
Create an Option using the current settings and with
the specified Option
char. |
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 the
Option matching the long or short name specified. |
Option[] |
CommandLine.getOptions() |
Returns an array of the processed
Options. |
| 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
|
java.util.Iterator<Option> |
CommandLine.iterator() |
Returns an iterator over the Option members of CommandLine.
|
| 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 specified
Option to this group. |
Options |
Options.addOption(Option opt) |
Adds an option instance
|
OptionGroup |
Options.getOptionGroup(Option opt) |
Returns the OptionGroup the
opt belongs to. |
void |
Parser.processArgs(Option opt,
java.util.ListIterator<java.lang.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 | Description |
|---|---|---|
void |
HelpFormatter.setOptionComparator(java.util.Comparator<Option> comparator) |
Set the comparator used to sort the options when they output in help text.
|
| Constructor | Description |
|---|---|
AlreadySelectedException(OptionGroup group,
Option option) |
Construct a new
AlreadySelectedException
for the specified option group. |
MissingArgumentException(Option option) |
Construct a new
MissingArgumentException
with the specified detail message. |