| 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.
|
| Class | Description |
|---|---|
| AlreadySelectedException |
Thrown when more than one option in an option group has been provided.
|
| CommandLine |
Represents list of arguments parsed against a
Options descriptor. |
| CommandLine.Builder |
A nested builder class to create
CommandLine instance using descriptive methods. |
| CommandLineParser |
A class that implements the
CommandLineParser interface can parse a String array according to the
Options specified and return a CommandLine. |
| Converter |
The definition of the functional interface to call when doing a conversion.
|
| DefaultParser |
Default parser.
|
| DefaultParser.Builder |
A nested builder class to create
DefaultParser instances
using descriptive methods. |
| DefaultParser.NonOptionAction |
Enum representing possible actions that may be done when "non option" is discovered during parsing.
|
| DeprecatedAttributes |
Deprecated attributes.
|
| DeprecatedAttributes.Builder |
Builds
DeprecatedAttributes. |
| HelpFormatter |
Deprecated.
Use
HelpFormatter. |
| HelpFormatter.Builder |
Deprecated.
Builds
HelpFormatter. |
| MissingOptionException |
Thrown when a required option has not been provided.
|
| Option |
Describes a single command-line option.
|
| Option.Builder |
Builds
Option instances using descriptive methods. |
| OptionBuilder |
Deprecated.
Since 1.3, use
Option.builder(String) instead. |
| OptionGroup |
A group of mutually exclusive options.
|
| Options |
Main entry-point into the library.
|
| ParseException |
Base for Exceptions thrown during parsing of a command-line.
|
| Parser |
Deprecated.
Since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases.
|
| TypeHandler |
TypeHandler will handle the pluggable conversion and verification of Option types.
|
| UnrecognizedOptionException |
Thrown during parsing signaling an unrecognized option.
|
| Class | Description |
|---|---|
| Option |
Describes a single command-line option.
|
| OptionGroup |
A group of mutually exclusive options.
|
| Options |
Main entry-point into the library.
|
Copyright © 2002-2025 The Apache Software Foundation. All rights reserved.Apache Commons CLI | Issue management | Source repository