/usr/share/doc/libjcommander-java/api/com/beust/jcommander/Parameter.html is in libjcommander-java-doc 1.71-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>Parameter (jcommander 1.71 API)</title>
<meta name="date" content="2018-02-15">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Parameter (jcommander 1.71 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/beust/jcommander/MissingCommandException.html" title="class in com.beust.jcommander"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/beust/jcommander/ParameterDescription.html" title="class in com.beust.jcommander"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/beust/jcommander/Parameter.html" target="_top">Frames</a></li>
<li><a href="Parameter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Field | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.beust.jcommander</div>
<h2 title="Annotation Type Parameter" class="title">Annotation Type Parameter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface <span class="memberNameLabel">Parameter</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#arity--">arity</a></span></code>
<div class="block">How many parameter values this parameter will consume.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../com/beust/jcommander/IStringConverter.html" title="interface in com.beust.jcommander">IStringConverter</a><?>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#converter--">converter</a></span></code>
<div class="block">The string converter to use for this field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#description--">description</a></span></code>
<div class="block">A description of this option.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#descriptionKey--">descriptionKey</a></span></code>
<div class="block">The key used to find the string in the message bundle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#echoInput--">echoInput</a></span></code>
<div class="block">If true, console will not echo typed input
Used in conjunction with password = true</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#forceNonOverwritable--">forceNonOverwritable</a></span></code>
<div class="block">If true, this parameter can be overwritten through a file or another appearance of the parameter</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#help--">help</a></span></code>
<div class="block">If true, this parameter is for help.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#hidden--">hidden</a></span></code>
<div class="block">If true, this parameter won't appear in the usage().</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../com/beust/jcommander/IStringConverter.html" title="interface in com.beust.jcommander">IStringConverter</a><?>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#listConverter--">listConverter</a></span></code>
<div class="block">The list string converter to use for this field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#names--">names</a></span></code>
<div class="block">An array of allowed command line parameters (e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#order--">order</a></span></code>
<div class="block">If specified, this number will be used to order the description of this parameter when usage() is invoked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#password--">password</a></span></code>
<div class="block">If true, this parameter is a password and it will be prompted on the console
(if available).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#required--">required</a></span></code>
<div class="block">Whether this option is required.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../com/beust/jcommander/converters/IParameterSplitter.html" title="interface in com.beust.jcommander.converters">IParameterSplitter</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#splitter--">splitter</a></span></code>
<div class="block">What splitter to use (applicable only on fields of type <tt>List</tt>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../com/beust/jcommander/IValueValidator.html" title="interface in com.beust.jcommander">IValueValidator</a>>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#validateValueWith--">validateValueWith</a></span></code>
<div class="block">Validate the value for this parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../com/beust/jcommander/IParameterValidator.html" title="interface in com.beust.jcommander">IParameterValidator</a>>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#validateWith--">validateWith</a></span></code>
<div class="block">Validate the parameter found on the command line.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/beust/jcommander/Parameter.html#variableArity--">variableArity</a></span></code> </td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="names--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>names</h4>
<pre>public abstract java.lang.String[] names</pre>
<div class="block">An array of allowed command line parameters (e.g. "-d", "--outputdir", etc...).
If this attribute is omitted, the field it's annotating will receive all the
unparsed options. There can only be at most one such annotation.</div>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="description--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract java.lang.String description</pre>
<div class="block">A description of this option.</div>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="required--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>required</h4>
<pre>public abstract boolean required</pre>
<div class="block">Whether this option is required.</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="descriptionKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>descriptionKey</h4>
<pre>public abstract java.lang.String descriptionKey</pre>
<div class="block">The key used to find the string in the message bundle.</div>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="arity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arity</h4>
<pre>public abstract int arity</pre>
<div class="block">How many parameter values this parameter will consume. For example,
an arity of 2 will allow "-pair value1 value2".</div>
<dl>
<dt>Default:</dt>
<dd>-1</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="password--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>password</h4>
<pre>public abstract boolean password</pre>
<div class="block">If true, this parameter is a password and it will be prompted on the console
(if available).</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="converter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>converter</h4>
<pre>public abstract java.lang.Class<? extends <a href="../../../com/beust/jcommander/IStringConverter.html" title="interface in com.beust.jcommander">IStringConverter</a><?>> converter</pre>
<div class="block">The string converter to use for this field. If the field is of type <tt>List</tt>
and not <tt>listConverter</tt> attribute was specified, JCommander will split
the input in individual values and convert each of them separately.</div>
<dl>
<dt>Default:</dt>
<dd>com.beust.jcommander.converters.NoConverter.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="listConverter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listConverter</h4>
<pre>public abstract java.lang.Class<? extends <a href="../../../com/beust/jcommander/IStringConverter.html" title="interface in com.beust.jcommander">IStringConverter</a><?>> listConverter</pre>
<div class="block">The list string converter to use for this field. If it's specified, the
field has to be of type <tt>List</tt> and the converter needs to return
a List that's compatible with that type.</div>
<dl>
<dt>Default:</dt>
<dd>com.beust.jcommander.converters.NoConverter.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="hidden--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hidden</h4>
<pre>public abstract boolean hidden</pre>
<div class="block">If true, this parameter won't appear in the usage().</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="validateWith--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateWith</h4>
<pre>public abstract java.lang.Class<? extends <a href="../../../com/beust/jcommander/IParameterValidator.html" title="interface in com.beust.jcommander">IParameterValidator</a>>[] validateWith</pre>
<div class="block">Validate the parameter found on the command line.</div>
<dl>
<dt>Default:</dt>
<dd>com.beust.jcommander.validators.NoValidator.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="validateValueWith--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateValueWith</h4>
<pre>public abstract java.lang.Class<? extends <a href="../../../com/beust/jcommander/IValueValidator.html" title="interface in com.beust.jcommander">IValueValidator</a>>[] validateValueWith</pre>
<div class="block">Validate the value for this parameter.</div>
<dl>
<dt>Default:</dt>
<dd>com.beust.jcommander.validators.NoValueValidator.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="variableArity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>variableArity</h4>
<pre>public abstract boolean variableArity</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this parameter has a variable arity. See @{IVariableArity}</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="splitter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>splitter</h4>
<pre>public abstract java.lang.Class<? extends <a href="../../../com/beust/jcommander/converters/IParameterSplitter.html" title="interface in com.beust.jcommander.converters">IParameterSplitter</a>> splitter</pre>
<div class="block">What splitter to use (applicable only on fields of type <tt>List</tt>). By default,
a comma separated splitter will be used.</div>
<dl>
<dt>Default:</dt>
<dd>com.beust.jcommander.converters.CommaParameterSplitter.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="echoInput--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>echoInput</h4>
<pre>public abstract boolean echoInput</pre>
<div class="block">If true, console will not echo typed input
Used in conjunction with password = true</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="help--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre>public abstract boolean help</pre>
<div class="block">If true, this parameter is for help. If such a parameter is specified,
required parameters are no longer checked for their presence.</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="forceNonOverwritable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceNonOverwritable</h4>
<pre>public abstract boolean forceNonOverwritable</pre>
<div class="block">If true, this parameter can be overwritten through a file or another appearance of the parameter</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>nc</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="order--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>order</h4>
<pre>public abstract int order</pre>
<div class="block">If specified, this number will be used to order the description of this parameter when usage() is invoked.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
<dl>
<dt>Default:</dt>
<dd>-1</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/beust/jcommander/MissingCommandException.html" title="class in com.beust.jcommander"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/beust/jcommander/ParameterDescription.html" title="class in com.beust.jcommander"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/beust/jcommander/Parameter.html" target="_top">Frames</a></li>
<li><a href="Parameter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Field | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|