| 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 | Method | Description |
|---|---|---|
Option.Builder |
Option.Builder.argName(String argName)
Sets the display name for the argument value.
|
|
static Option.Builder |
Option.builder()
Returns a
Option.Builder to create an Option using descriptive methods. |
|
static Option.Builder |
Option.builder(String option)
Returns a
Option.Builder to create an Option using descriptive methods. |
|
Option.Builder |
Option.Builder.converter(Converter<?,?> converter)
Sets the converter for the option.
|
|
Option.Builder |
Option.Builder.deprecated()
Marks this Option as deprecated.
|
|
Option.Builder |
Option.Builder.deprecated(DeprecatedAttributes deprecated)
Sets whether the Option is deprecated.
|
|
Option.Builder |
Option.Builder.desc(String description)
Sets the description for this option.
|
|
Option.Builder |
Option.Builder.hasArg()
Tests whether the Option will require an argument.
|
|
Option.Builder |
Option.Builder.hasArg(boolean hasArg)
Tests whether the Option has an argument or not.
|
|
Option.Builder |
Option.Builder.hasArgs()
Tests whether the Option can have unlimited argument values.
|
|
Option.Builder |
Option.Builder.longOpt(String longOption)
Sets the long name of the Option.
|
|
Option.Builder |
Option.Builder.numberOfArgs(int argCount)
Sets the number of argument values the Option can take.
|
|
Option.Builder |
Option.Builder.option(String option)
Sets the name of the Option.
|
|
Option.Builder |
Option.Builder.optionalArg(boolean optionalArg)
Sets whether the Option can have an optional argument.
|
|
Option.Builder |
Option.Builder.required()
Marks this Option as required.
|
|
Option.Builder |
Option.Builder.required(boolean required)
Sets whether the Option is required.
|
|
Option.Builder |
Option.Builder.since(String since)
Sets the version number when this option was first defined."
|
|
Option.Builder |
Option.Builder.type(Class<?> type)
Sets the type of the Option.
|
|
Option.Builder |
Option.Builder.valueSeparator()
The Option will use '=' as a means to separate argument value.
|
|
Option.Builder |
Option.Builder.valueSeparator(char valueSeparator)
The Option will use
sep as a means to separate argument values. |
Copyright © 2002-2025 The Apache Software Foundation. All rights reserved.Apache Commons CLI | Issue management | Source repository