Skip to content

[CLI-335] Updated properties documentation #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garydgregory merged 1 commit into from
Jun 12, 2024
Merged

[CLI-335] Updated properties documentation #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 46 additions & 34 deletions src/site/xdoc/properties.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these
can be set using the accessors or using the methods
defined in the
<a href="javadocs/api-release/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
<a href="javadocs/api-release/org/apache/commons/cli/Option.Builder.html">Option.Builder</a>.
</p>
<table>
<tr>
Expand All @@ -40,68 +40,80 @@
<th>Description</th>
</tr>
<tr>
<td>opt</td>
<td>java.lang.String</td>
<td>the identification string of the Option.</td>
<td>arg</td>
<td>boolean</td>
<td>A flag to say whether the option takes an argument.</td>
</tr>
<tr>
<td>longOpt</td>
<td>java.lang.String</td>
<td>an alias and more descriptive identification string</td>
<td>args</td>
<td>boolean</td>
<td>A flag to say whether the option takes more than one argument.</td>
</tr>
<tr>
<td>description</td>
<td>argName</td>
<td>java.lang.String</td>
<td>a description of the function of the option</td>
<td>The name of the argument value for the usage statement.</td>
</tr>
<tr>
<td>required</td>
<td>boolean</td>
<td>a flag to say whether the option <b>must</b> appear on
the command line.</td>
<td>converter</td>
<td>org.apache.commons.cli.Converter&lt;T, E extends Throwable&gt;</td>
<td>A FunctionalInterface that converts a String to type T and may throw an exception E. When
CommandLine.getParsedValue() is called this FunctionalInterface will perform the conversion from the
command line argument to the parsed type. This is used when a desired type is not registered, or to
provide a custom type implementation. The 'type' property is not required to use the 'converter' property.</td>
</tr>
<tr>
<td>arg</td>
<td>boolean</td>
<td>a flag to say whether the option takes an argument</td>
<td>deprecated</td>
<td>org.apache.commons.cli.DeprecatedAttributes</td>
<td>Marks the option as deprecated and has the deprecation properties.</td>
</tr>
<tr>
<td>args</td>
<td>boolean</td>
<td>a flag to say whether the option takes more than one argument</td>
<td>description</td>
<td>java.lang.String</td>
<td>A description of the function of the option.</td>
</tr>
<tr>
<td>optionalArg</td>
<td>boolean</td>
<td>a flag to say whether the option's argument is optional</td>
<td>longOpt</td>
<td>java.lang.String</td>
<td>An alias and more descriptive identification string. May be null or not specified if 'opt' is provided.</td>
</tr>
<tr>
<td>argName</td>
<td>opt</td>
<td>java.lang.String</td>
<td>the name of the argument value for the usage statement</td>
<td>The identification string of the Option. May be null or not specified if 'longOpt' is provided.</td>
</tr>
<tr>
<td>valueSeparator</td>
<td>char</td>
<td>the character value used to split the argument string, that
is used in conjunction with multipleArgs e.g.
if the separator is ',' and the argument string is 'a,b,c' then
there are three argument values, 'a', 'b' and 'c'.</td>
<td>optionalArg</td>
<td>boolean</td>
<td>A flag to say whether the option's argument is optional.</td>
</tr>
<tr>
<td>required</td>
<td>boolean</td>
<td>A flag to say whether the option <b>must</b> appear on the command line.</td>
</tr>
<tr>
<td>type</td>
<td>java.lang.Object</td>
<td>the type of the argument</td>
<td>java.lang.Class&lt;?&gt;</td>
<td>The class of the object returned from getParsedValue(). The class must be registered in TypeHandler instance.
See also 'converter' property.</td>
</tr>
<tr>
<td>value</td>
<td>java.lang.String</td>
<td>the value of the option</td>
<td>The value of the option.</td>
</tr>
<tr>
<td>values</td>
<td>java.lang.String[]</td>
<td>the values of the option</td>
<td>The values of the option.</td>
</tr>
<tr>
<td>valueSeparator</td>
<td>char</td>
<td>The character value used to split the argument string, that is used in conjunction with multipleArgs e.g.
if the separator is ',' and the argument string is 'a,b,c' then there are three argument values, 'a', 'b'
and 'c'.</td>
</tr>
</table>
</section>
Expand Down