| Interface | Description |
|---|---|
| HelpFormatter |
Represents objects charged with taking a set of option descriptions and producing some help text from them.
|
| OptionDescriptor |
Describes options that an option parser recognizes, in ways that might be useful to help screens.
|
| OptionSpec<V> |
Describes options that an option parser recognizes.
|
| ValueConverter<V> |
Instances of this interface are used to convert arguments of options into specific Java types.
|
| Class | Description |
|---|---|
| ArgumentAcceptingOptionSpec<V> |
Specification of an option that accepts an argument.
|
| OptionParser |
Parses command line arguments, using a syntax that attempts to take from the best of POSIX
getopt()
and GNU getopt_long(). |
| OptionSet |
Representation of a group of detected command line options, their arguments, and non-option arguments.
|
| OptionSpecBuilder |
Allows callers to specify whether a given option accepts arguments (required or optional).
|
| Exception | Description |
|---|---|
| IllegalOptionSpecificationException |
Thrown when the option parser is asked to recognize an option with illegal characters in it.
|
| MissingRequiredOptionException |
Thrown when an option is marked as required, but not specified on the command line.
|
| MultipleArgumentsForOptionException |
Thrown when asking an
OptionSet for a single argument of an option when many have been specified. |
| OptionArgumentConversionException |
Thrown when a problem occurs converting an argument of an option from
String to another type. |
| OptionException |
Thrown when a problem occurs during option parsing.
|
| OptionMissingRequiredArgumentException |
Thrown when the option parser discovers an option that requires an argument, but that argument is missing.
|
| UnrecognizedOptionException |
Thrown when the option parser encounters an unrecognized option.
|
| ValueConversionException |
Thrown by
ValueConverters when problems occur in converting string values to other Java types. |