1 |
d2a8c3fd
|
Marc NICOLAS
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
|
2 |
|
|
|
3 |
|
|
<html>
|
4 |
|
|
<head>
|
5 |
|
|
|
6 |
|
|
<title>
|
7 |
|
|
Class gnu.getopt.LongOpt
|
8 |
|
|
</title>
|
9 |
|
|
</head>
|
10 |
|
|
<body>
|
11 |
|
|
<a name="_top_"></a>
|
12 |
|
|
<pre>
|
13 |
|
|
<a href="packages.html">All Packages</a> <a href="tree.html">Class Hierarchy</a> <a href="Package-gnu.getopt.html">This Package</a> <a href="Package-gnu.getopt.html">Previous</a> <a href="Package-gnu.getopt.html">Next</a> <a href="AllNames.html">Index</a></pre>
|
14 |
|
|
<hr>
|
15 |
|
|
<h1>
|
16 |
|
|
Class gnu.getopt.LongOpt
|
17 |
|
|
</h1>
|
18 |
|
|
<pre>
|
19 |
|
|
java.lang.Object
|
20 |
|
|
|
|
21 |
|
|
+----gnu.getopt.LongOpt
|
22 |
|
|
</pre>
|
23 |
|
|
<hr>
|
24 |
|
|
<dl>
|
25 |
|
|
<dt> public class <b>LongOpt</b>
|
26 |
|
|
<dt> extends Object
|
27 |
|
|
</dl>
|
28 |
|
|
This object represents the definition of a long option in the Java port
|
29 |
|
|
of GNU getopt. An array of LongOpt objects is passed to the Getopt
|
30 |
|
|
object to define the list of valid long options for a given parsing
|
31 |
|
|
session. Refer to the getopt documentation for details on the
|
32 |
|
|
format of long options.
|
33 |
|
|
<p>
|
34 |
|
|
<dl>
|
35 |
|
|
<dt> <b>Version:</b>
|
36 |
|
|
<dd> 1.0.3
|
37 |
|
|
<dt> <b>Author:</b>
|
38 |
|
|
<dd> Aaron M. Renn (arenn@urbanophile.com)
|
39 |
|
|
<dt> <b>See Also:</b>
|
40 |
|
|
<dd> <a href="gnu.getopt.Getopt.html#_top_">Getopt</a>
|
41 |
|
|
</dl>
|
42 |
|
|
<hr>
|
43 |
|
|
<a name="index"></a>
|
44 |
|
|
<h2>
|
45 |
|
|
<img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
|
46 |
|
|
</h2>
|
47 |
|
|
<dl>
|
48 |
|
|
<dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
|
49 |
|
|
<a href="#NO_ARGUMENT"><b>NO_ARGUMENT</b></a>
|
50 |
|
|
<dd> Constant value used for the "has_arg" constructor argument.
|
51 |
|
|
<dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
|
52 |
|
|
<a href="#OPTIONAL_ARGUMENT"><b>OPTIONAL_ARGUMENT</b></a>
|
53 |
|
|
<dd> Constant value used for the "has_arg" constructor argument.
|
54 |
|
|
<dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
|
55 |
|
|
<a href="#REQUIRED_ARGUMENT"><b>REQUIRED_ARGUMENT</b></a>
|
56 |
|
|
<dd>
|
57 |
|
|
Constant value used for the "has_arg" constructor argument.
|
58 |
|
|
</dl>
|
59 |
|
|
<h2>
|
60 |
|
|
<img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
|
61 |
|
|
</h2>
|
62 |
|
|
<dl>
|
63 |
|
|
<dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
|
64 |
|
|
<a href="#LongOpt(java.lang.String, int, java.lang.StringBuffer, int)"><b>LongOpt</b></a>(String, int, StringBuffer, int)
|
65 |
|
|
<dd> Create a new LongOpt object with the given parameter values.
|
66 |
|
|
</dl>
|
67 |
|
|
<h2>
|
68 |
|
|
<img src="images/method-index.gif" width=207 height=38 alt="Method Index">
|
69 |
|
|
</h2>
|
70 |
|
|
<dl>
|
71 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
72 |
|
|
<a href="#getFlag()"><b>getFlag</b></a>()
|
73 |
|
|
<dd> Returns the value of the 'flag' field for this long option
|
74 |
|
|
|
75 |
|
|
|
76 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
77 |
|
|
<a href="#getHasArg()"><b>getHasArg</b></a>()
|
78 |
|
|
<dd> Returns the value set for the 'has_arg' field for this long option
|
79 |
|
|
|
80 |
|
|
|
81 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
82 |
|
|
<a href="#getName()"><b>getName</b></a>()
|
83 |
|
|
<dd> Returns the name of this LongOpt as a String
|
84 |
|
|
|
85 |
|
|
|
86 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
87 |
|
|
<a href="#getVal()"><b>getVal</b></a>()
|
88 |
|
|
<dd> Returns the value of the 'val' field for this long option
|
89 |
|
|
|
90 |
|
|
|
91 |
|
|
</dl>
|
92 |
|
|
<a name="variables"></a>
|
93 |
|
|
<h2>
|
94 |
|
|
<img src="images/variables.gif" width=153 height=38 alt="Variables">
|
95 |
|
|
</h2>
|
96 |
|
|
<a name="NO_ARGUMENT"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
|
97 |
|
|
<b>NO_ARGUMENT</b>
|
98 |
|
|
<pre>
|
99 |
|
|
public static final int NO_ARGUMENT
|
100 |
|
|
</pre>
|
101 |
|
|
<dl>
|
102 |
|
|
<dd> Constant value used for the "has_arg" constructor argument. This
|
103 |
|
|
value indicates that the option takes no argument.<p>
|
104 |
|
|
</dl>
|
105 |
|
|
<a name="REQUIRED_ARGUMENT"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
|
106 |
|
|
<b>REQUIRED_ARGUMENT</b>
|
107 |
|
|
<pre>
|
108 |
|
|
public static final int REQUIRED_ARGUMENT
|
109 |
|
|
</pre>
|
110 |
|
|
<dl>
|
111 |
|
|
<dd> Constant value used for the "has_arg" constructor argument. This
|
112 |
|
|
value indicates that the option takes an argument that is required.<p>
|
113 |
|
|
</dl>
|
114 |
|
|
<a name="OPTIONAL_ARGUMENT"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
|
115 |
|
|
<b>OPTIONAL_ARGUMENT</b>
|
116 |
|
|
<pre>
|
117 |
|
|
public static final int OPTIONAL_ARGUMENT
|
118 |
|
|
</pre>
|
119 |
|
|
<dl>
|
120 |
|
|
<dd> Constant value used for the "has_arg" constructor argument. This
|
121 |
|
|
value indicates that the option takes an argument that is optional.<p>
|
122 |
|
|
</dl>
|
123 |
|
|
<a name="constructors"></a>
|
124 |
|
|
<h2>
|
125 |
|
|
<img src="images/constructors.gif" width=231 height=38 alt="Constructors">
|
126 |
|
|
</h2>
|
127 |
|
|
<a name="LongOpt"></a>
|
128 |
|
|
<a name="LongOpt(java.lang.String, int, java.lang.StringBuffer, int)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
|
129 |
|
|
<b>LongOpt</b>
|
130 |
|
|
<pre>
|
131 |
|
|
public LongOpt(String name,
|
132 |
|
|
int has_arg,
|
133 |
|
|
StringBuffer flag,
|
134 |
|
|
int val) throws IllegalArgumentException
|
135 |
|
|
</pre>
|
136 |
|
|
<dl>
|
137 |
|
|
<dd> Create a new LongOpt object with the given parameter values. If the
|
138 |
|
|
value passed as has_arg is not valid, then an exception is thrown.
|
139 |
|
|
<p>
|
140 |
|
|
<dd><dl>
|
141 |
|
|
<dt> <b>Parameters:</b>
|
142 |
|
|
<dd> name - The long option String.
|
143 |
|
|
<dd> has_arg - Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT).
|
144 |
|
|
<dd> flag - If non-null, this is a location to store the value of "val" when this option is encountered, otherwise "val" is treated as the equivalent short option character.
|
145 |
|
|
<dd> val - The value to return for this long option, or the equivalent single letter option to emulate if flag is null.
|
146 |
|
|
<dt> <b>Throws:</b> IllegalArgumentException
|
147 |
|
|
<dd> If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT.
|
148 |
|
|
</dl></dd>
|
149 |
|
|
</dl>
|
150 |
|
|
<a name="methods"></a>
|
151 |
|
|
<h2>
|
152 |
|
|
<img src="images/methods.gif" width=151 height=38 alt="Methods">
|
153 |
|
|
</h2>
|
154 |
|
|
<a name="getName()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
155 |
|
|
<a name="getName"><b>getName</b></a>
|
156 |
|
|
<pre>
|
157 |
|
|
public String getName()
|
158 |
|
|
</pre>
|
159 |
|
|
<dl>
|
160 |
|
|
<dd> Returns the name of this LongOpt as a String
|
161 |
|
|
<p>
|
162 |
|
|
<dd><dl>
|
163 |
|
|
<dt> <b>Returns:</b>
|
164 |
|
|
<dd> Then name of the long option
|
165 |
|
|
</dl></dd>
|
166 |
|
|
</dl>
|
167 |
|
|
<a name="getHasArg()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
168 |
|
|
<a name="getHasArg"><b>getHasArg</b></a>
|
169 |
|
|
<pre>
|
170 |
|
|
public int getHasArg()
|
171 |
|
|
</pre>
|
172 |
|
|
<dl>
|
173 |
|
|
<dd> Returns the value set for the 'has_arg' field for this long option
|
174 |
|
|
<p>
|
175 |
|
|
<dd><dl>
|
176 |
|
|
<dt> <b>Returns:</b>
|
177 |
|
|
<dd> The value of 'has_arg'
|
178 |
|
|
</dl></dd>
|
179 |
|
|
</dl>
|
180 |
|
|
<a name="getFlag()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
181 |
|
|
<a name="getFlag"><b>getFlag</b></a>
|
182 |
|
|
<pre>
|
183 |
|
|
public StringBuffer getFlag()
|
184 |
|
|
</pre>
|
185 |
|
|
<dl>
|
186 |
|
|
<dd> Returns the value of the 'flag' field for this long option
|
187 |
|
|
<p>
|
188 |
|
|
<dd><dl>
|
189 |
|
|
<dt> <b>Returns:</b>
|
190 |
|
|
<dd> The value of 'flag'
|
191 |
|
|
</dl></dd>
|
192 |
|
|
</dl>
|
193 |
|
|
<a name="getVal()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
194 |
|
|
<a name="getVal"><b>getVal</b></a>
|
195 |
|
|
<pre>
|
196 |
|
|
public int getVal()
|
197 |
|
|
</pre>
|
198 |
|
|
<dl>
|
199 |
|
|
<dd> Returns the value of the 'val' field for this long option
|
200 |
|
|
<p>
|
201 |
|
|
<dd><dl>
|
202 |
|
|
<dt> <b>Returns:</b>
|
203 |
|
|
<dd> The value of 'val'
|
204 |
|
|
</dl></dd>
|
205 |
|
|
</dl>
|
206 |
|
|
<hr>
|
207 |
|
|
<pre>
|
208 |
|
|
<a href="packages.html">All Packages</a> <a href="tree.html">Class Hierarchy</a> <a href="Package-gnu.getopt.html">This Package</a> <a href="Package-gnu.getopt.html">Previous</a> <a href="Package-gnu.getopt.html">Next</a> <a href="AllNames.html">Index</a></pre>
|
209 |
|
|
</body>
|
210 |
|
|
</html> |