1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<?xml version="1.0"?>
<document>
<properties>
<author email="john@integralsource.com">John Keyes</author>
<title>Option Properties</title>
</properties>
<body>
<section name="Option Properties">
<p>
The following are the properties that each
<a href="apidocs/org/apache/commons/cli/Options.html">Option</a> has. All of these
can be set using the accessors or using the methods
defined on the
<a href="apidocs/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
</p>
<table>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>opt</td>
<td>java.lang.String</td>
<td>the identification string of the Option.</td>
</tr>
<tr>
<td>longOpt</td>
<td>java.lang.String</td>
<td>an alias and more descriptive identification string</td>
</tr>
<tr>
<td>description</td>
<td>java.lang.String</td>
<td>a description of the function of the option</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>multipleArgs</td>
<td>boolean</td>
<td>a flag to say whether the option takes multiple argument
values</td>
</tr>
<tr>
<td>arg</td>
<td>boolean</td>
<td>a flag to say whether the option takes an argument</td>
</tr>
<tr>
<td>args</td>
<td>boolean</td>
<td>a flag to say whether the option takes more than one argument</td>
</tr>
<tr>
<td>optionalArg</td>
<td>boolean</td>
<td>a flag to say whether the option's argument is optional</td>
</tr>
<tr>
<td>argName</td>
<td>java.lang.String</td>
<td>the name of the argument value for the usage statement</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>
<tr>
<td>type</td>
<td>java.lang.Object</td>
<td>the type of the argument</td>
</tr>
<tr>
<td>value</td>
<td>java.lang.String</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>
</tr>
</table>
</section>
</body>
</document>
|
