| Package | Description |
|---|---|
| org.apache.commons.cli |
Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
AlreadySelectedException
Thrown when more than one option in an option group has been provided.
|
|
class |
AmbiguousOptionException
Exception thrown when an option can't be identified from a partial name.
|
|
class |
MissingArgumentException
Thrown when an option requiring an argument is not provided with an argument.
|
|
class |
MissingOptionException
Thrown when a required option has not been provided.
|
|
class |
UnrecognizedOptionException
Thrown during parsing signaling an unrecognized option.
|
| Modifier and Type | Method | Description |
|---|---|---|
static ParseException |
ParseException.wrap(Throwable e)
Converts any exception except
UnsupportedOperationException to a ParseException. if e is an instance of ParseException it
is returned, otherwise a ParseException is created that wraps it. |
| Modifier and Type | Method | Description |
|---|---|---|
static Class<?> |
TypeHandler.createClass(String className)
Returns the class whose name is
className. |
|
static Number |
TypeHandler.createNumber(String string)
Deprecated.
|
|
static Object |
TypeHandler.createObject(String className)
Deprecated.
|
|
static URL |
TypeHandler.createURL(String string)
Creates the URL represented by
string. |
|
static <T> T |
TypeHandler.createValue(String string,
Class<T> clazz)
Creates the @code Object} of type
clazz with the value of string. |
|
static Object |
TypeHandler.createValue(String string,
Object obj)
Deprecated.
|
|
protected String[] |
PosixParser.flatten(Options options,
String[] arguments,
boolean stopAtNonOption)
Deprecated.
|
|
protected abstract String[] |
Parser.flatten(Options opts,
String[] arguments,
boolean stopAtNonOption)
Deprecated.
Subclasses must implement this method to reduce the
arguments that have been passed to the parse method. |
|
<T> T |
CommandLine.getParsedOptionValue(char optionChar)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(char optionChar,
Supplier<T> defaultValue)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(char optionChar,
T defaultValue)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(Option option)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(OptionGroup optionGroup)
Gets a version of this
OptionGroup converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(OptionGroup optionGroup,
Supplier<T> defaultValue)
Gets a version of this
OptionGroup converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(OptionGroup optionGroup,
T defaultValue)
Gets a version of this
OptionGroup converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(Option option,
Supplier<T> defaultValue)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(Option option,
T defaultValue)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(String optionName)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(String optionName,
Supplier<T> defaultValue)
Gets a version of this
Option converted to a particular type. |
|
<T> T |
CommandLine.getParsedOptionValue(String optionName,
T defaultValue)
Gets a version of this
Option converted to a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(char optionChar)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(char optionChar,
Supplier<T[]> defaultValue)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(char optionChar,
T[] defaultValue)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(Option option)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(OptionGroup optionGroup)
Gets a version of this
OptionGroup converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(OptionGroup optionGroup,
Supplier<T[]> defaultValue)
Gets a version of this
OptionGroup converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(OptionGroup optionGroup,
T[] defaultValue)
Gets a version of this
OptionGroup converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(Option option,
Supplier<T[]> defaultValue)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(Option option,
T[] defaultValue)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(String optionName)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(String optionName,
Supplier<T[]> defaultValue)
Gets a version of this
Option converted to an array of a particular type. |
|
<T> T[] |
CommandLine.getParsedOptionValues(String optionName,
T[] defaultValue)
Gets a version of this
Option converted to an array of a particular type. |
|
protected void |
DefaultParser.handleConcatenatedOptions(String token)
Breaks
token into its constituent parts using the following algorithm. |
|
protected void |
DefaultParser.handleUnknownToken(String token)
Handles an unknown token.
|
|
static FileInputStream |
TypeHandler.openFile(String string)
Deprecated.
|
|
CommandLine |
DefaultParser.parse(Options options,
Properties properties,
DefaultParser.NonOptionAction nonOptionAction,
String... arguments)
Parses the arguments according to the specified options and properties.
|
|
CommandLine |
DefaultParser.parse(Options options,
String[] arguments) |
|
CommandLine |
CommandLineParser.parse(Options options,
String[] arguments)
Parses the arguments according to the specified options.
|
|
CommandLine |
Parser.parse(Options options,
String[] arguments)
Deprecated.
Parses the specified
arguments based on the specified Options. |
|
CommandLine |
DefaultParser.parse(Options options,
String[] arguments,
boolean stopAtNonOption) |
|
CommandLine |
CommandLineParser.parse(Options options,
String[] arguments,
boolean stopAtNonOption)
Parses the arguments according to the specified options.
|
|
CommandLine |
Parser.parse(Options options,
String[] arguments,
boolean stopAtNonOption)
Deprecated.
Parses the specified
arguments based on the specified Options. |
|
CommandLine |
DefaultParser.parse(Options options,
String[] arguments,
Properties properties)
Parses the arguments according to the specified options and properties.
|
|
CommandLine |
Parser.parse(Options options,
String[] arguments,
Properties properties)
Deprecated.
Parses the arguments according to the specified options and properties.
|
|
CommandLine |
DefaultParser.parse(Options options,
String[] arguments,
Properties properties,
boolean stopAtNonOption)
Parses the arguments according to the specified options and properties.
|
|
CommandLine |
Parser.parse(Options options,
String[] arguments,
Properties properties,
boolean stopAtNonOption)
Deprecated.
Parses the arguments according to the specified options and properties.
|
|
void |
Parser.processArgs(Option opt,
ListIterator<String> iter)
Deprecated.
Processes the argument values for the specified Option
opt using the values retrieved from the specified
iterator iter. |
|
protected void |
Parser.processOption(String arg,
ListIterator<String> iter)
Deprecated.
Processes the Option specified by
arg using the values retrieved from the specified iterator
iter. |
|
protected void |
Parser.processProperties(Properties properties)
Deprecated.
Sets the values of Options using the values in
properties. |
Copyright © 2002-2025 The Apache Software Foundation. All rights reserved.Apache Commons CLI | Issue management | Source repository