Skip to content

Commit 73946f3

Browse files
authored
updated properties documentation (apache#285)
1 parent 296e262 commit 73946f3

1 file changed

Lines changed: 46 additions & 34 deletions

File tree

src/site/xdoc/properties.xml

Lines changed: 46 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these
3232
can be set using the accessors or using the methods
3333
defined in the
34-
<a href="javadocs/api-release/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
34+
<a href="javadocs/api-release/org/apache/commons/cli/Option.Builder.html">Option.Builder</a>.
3535
</p>
3636
<table>
3737
<tr>
@@ -40,68 +40,80 @@
4040
<th>Description</th>
4141
</tr>
4242
<tr>
43-
<td>opt</td>
44-
<td>java.lang.String</td>
45-
<td>the identification string of the Option.</td>
43+
<td>arg</td>
44+
<td>boolean</td>
45+
<td>A flag to say whether the option takes an argument.</td>
4646
</tr>
4747
<tr>
48-
<td>longOpt</td>
49-
<td>java.lang.String</td>
50-
<td>an alias and more descriptive identification string</td>
48+
<td>args</td>
49+
<td>boolean</td>
50+
<td>A flag to say whether the option takes more than one argument.</td>
5151
</tr>
5252
<tr>
53-
<td>description</td>
53+
<td>argName</td>
5454
<td>java.lang.String</td>
55-
<td>a description of the function of the option</td>
55+
<td>The name of the argument value for the usage statement.</td>
5656
</tr>
5757
<tr>
58-
<td>required</td>
59-
<td>boolean</td>
60-
<td>a flag to say whether the option <b>must</b> appear on
61-
the command line.</td>
58+
<td>converter</td>
59+
<td>org.apache.commons.cli.Converter&lt;T, E extends Throwable&gt;</td>
60+
<td>A FunctionalInterface that converts a String to type T and may throw an exception E. When
61+
CommandLine.getParsedValue() is called this FunctionalInterface will perform the conversion from the
62+
command line argument to the parsed type. This is used when a desired type is not registered, or to
63+
provide a custom type implementation. The 'type' property is not required to use the 'converter' property.</td>
6264
</tr>
6365
<tr>
64-
<td>arg</td>
65-
<td>boolean</td>
66-
<td>a flag to say whether the option takes an argument</td>
66+
<td>deprecated</td>
67+
<td>org.apache.commons.cli.DeprecatedAttributes</td>
68+
<td>Marks the option as deprecated and has the deprecation properties.</td>
6769
</tr>
6870
<tr>
69-
<td>args</td>
70-
<td>boolean</td>
71-
<td>a flag to say whether the option takes more than one argument</td>
71+
<td>description</td>
72+
<td>java.lang.String</td>
73+
<td>A description of the function of the option.</td>
7274
</tr>
7375
<tr>
74-
<td>optionalArg</td>
75-
<td>boolean</td>
76-
<td>a flag to say whether the option's argument is optional</td>
76+
<td>longOpt</td>
77+
<td>java.lang.String</td>
78+
<td>An alias and more descriptive identification string. May be null or not specified if 'opt' is provided.</td>
7779
</tr>
7880
<tr>
79-
<td>argName</td>
81+
<td>opt</td>
8082
<td>java.lang.String</td>
81-
<td>the name of the argument value for the usage statement</td>
83+
<td>The identification string of the Option. May be null or not specified if 'longOpt' is provided.</td>
8284
</tr>
8385
<tr>
84-
<td>valueSeparator</td>
85-
<td>char</td>
86-
<td>the character value used to split the argument string, that
87-
is used in conjunction with multipleArgs e.g.
88-
if the separator is ',' and the argument string is 'a,b,c' then
89-
there are three argument values, 'a', 'b' and 'c'.</td>
86+
<td>optionalArg</td>
87+
<td>boolean</td>
88+
<td>A flag to say whether the option's argument is optional.</td>
89+
</tr>
90+
<tr>
91+
<td>required</td>
92+
<td>boolean</td>
93+
<td>A flag to say whether the option <b>must</b> appear on the command line.</td>
9094
</tr>
9195
<tr>
9296
<td>type</td>
93-
<td>java.lang.Object</td>
94-
<td>the type of the argument</td>
97+
<td>java.lang.Class&lt;?&gt;</td>
98+
<td>The class of the object returned from getParsedValue(). The class must be registered in TypeHandler instance.
99+
See also 'converter' property.</td>
95100
</tr>
96101
<tr>
97102
<td>value</td>
98103
<td>java.lang.String</td>
99-
<td>the value of the option</td>
104+
<td>The value of the option.</td>
100105
</tr>
101106
<tr>
102107
<td>values</td>
103108
<td>java.lang.String[]</td>
104-
<td>the values of the option</td>
109+
<td>The values of the option.</td>
110+
</tr>
111+
<tr>
112+
<td>valueSeparator</td>
113+
<td>char</td>
114+
<td>The character value used to split the argument string, that is used in conjunction with multipleArgs e.g.
115+
if the separator is ',' and the argument string is 'a,b,c' then there are three argument values, 'a', 'b'
116+
and 'c'.</td>
105117
</tr>
106118
</table>
107119
</section>

0 commit comments

Comments
 (0)