/usr/share/doc/libargparse4j-java/api/net/sourceforge/argparse4j/inf/Argument.html is in libargparse4j-java-doc 0.4.4-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 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_75) on Wed Feb 18 23:12:12 UTC 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Argument (argparse4j 0.4.4-SNAPSHOT API)</title>
<meta name="date" content="2015-02-18">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Argument (argparse4j 0.4.4-SNAPSHOT API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Argument.html">Use</a></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>Prev Class</li>
<li><a href="../../../../net/sourceforge/argparse4j/inf/ArgumentAction.html" title="interface in net.sourceforge.argparse4j.inf"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?net/sourceforge/argparse4j/inf/Argument.html" target="_top">Frames</a></li>
<li><a href="Argument.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>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</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">net.sourceforge.argparse4j.inf</div>
<h2 title="Interface Argument" class="title">Interface Argument</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../net/sourceforge/argparse4j/internal/ArgumentImpl.html" title="class in net.sourceforge.argparse4j.internal">ArgumentImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Argument</span></pre>
<div class="block">This interface provides a way to specify parameters to argument to be
processed in <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentParser.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentParser</code></a> object.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#action(net.sourceforge.argparse4j.inf.ArgumentAction)">action</a></strong>(<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentAction.html" title="interface in net.sourceforge.argparse4j.inf">ArgumentAction</a> action)</code>
<div class="block">Sets the action to be taken when this argument is encountered at the
command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#choices(net.sourceforge.argparse4j.inf.ArgumentChoice)">choices</a></strong>(<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentChoice.html" title="interface in net.sourceforge.argparse4j.inf">ArgumentChoice</a> choice)</code>
<div class="block">
Sets <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentChoice.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentChoice</code></a> object which inspects value so that it
fulfills its criteria.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#choices(java.util.Collection)">choices</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><E> values)</code>
<div class="block">Sets a collection of the allowable values for the argument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#choices(E...)">choices</a></strong>(E... values)</code>
<div class="block">Sets a collection of the allowable values for the argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#dest(java.lang.String)">dest</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dest)</code>
<div class="block">
The name of the attribute to be added.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#getConst()">getConst</a></strong>()</code>
<div class="block">Returns const value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#getDefault()">getDefault</a></strong>()</code>
<div class="block">Returns default value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#getDefaultControl()">getDefaultControl</a></strong>()</code>
<div class="block">Returns default control.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#getDest()">getDest</a></strong>()</code>
<div class="block">Returns dest value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#getHelpControl()">getHelpControl</a></strong>()</code>
<div class="block">Returns help control.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#help(net.sourceforge.argparse4j.inf.FeatureControl)">help</a></strong>(<a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a> ctrl)</code>
<div class="block">
Sets special value to control help message handling.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#help(java.lang.String)">help</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> help)</code>
<div class="block">Sets the brief description of what the argument does.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#metavar(java.lang.String...)">metavar</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... metavar)</code>
<div class="block">Set the name for the argument in usage messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#nargs(int)">nargs</a></strong>(int n)</code>
<div class="block">
Sets the number of command line arguments that should be consumed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#nargs(java.lang.String)">nargs</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> n)</code>
<div class="block">
Sets the number of command line arguments that should be consumed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#required(boolean)">required</a></strong>(boolean required)</code>
<div class="block">
If <code>true</code> is given, this optional argument must be specified in
command line otherwise error will be issued.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setConst(E...)">setConst</a></strong>(E... values)</code>
<div class="block">
Sets list of constant values that are not read from the command line but
are required for the various actions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setConst(java.lang.Object)">setConst</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
<div class="block">
Sets constant values that are not read from the command line but are
required for the various actions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setDefault(E...)">setDefault</a></strong>(E... values)</code>
<div class="block">
Sets list of values which should be used if the command line argument is
not present.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setDefault(net.sourceforge.argparse4j.inf.FeatureControl)">setDefault</a></strong>(<a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a> ctrl)</code>
<div class="block">
Sets special value to control default value handling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setDefault(java.lang.Object)">setDefault</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
<div class="block">
Sets value which should be used if the command line argument is not
present.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#textualName()">textualName</a></strong>()</code>
<div class="block">
Returns textual representation of the argument name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#type(net.sourceforge.argparse4j.inf.ArgumentType)">type</a></strong>(<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentType.html" title="interface in net.sourceforge.argparse4j.inf">ArgumentType</a><T> type)</code>
<div class="block">
Sets <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentType.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentType</code></a> object which converts command line argument to
appropriate type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a></code></td>
<td class="colLast"><code><strong><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#type(java.lang.Class)">type</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code>
<div class="block">
Sets the type which the command line argument should be converted to.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="nargs(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nargs</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> nargs(int n)</pre>
<div class="block"><p>
Sets the number of command line arguments that should be consumed.
</p>
<p>
Don't give this method <code>'*'</code>, <code>'+'</code> or <code>'?'</code>. They are
converted to <code>int</code> value and it is not what you expect. For these
strings, use <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#nargs(java.lang.String)"><code>nargs(String)</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - A positive integer</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="nargs(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nargs</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> nargs(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> n)</pre>
<div class="block"><p>
Sets the number of command line arguments that should be consumed.
<p>
<p>
This method takes one of following string: <code>"*"</code>, <code>"+"</code> and
<code>"?"</code>. If <code>"*"</code> is given, All command line arguments present
are gathered into a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>. If <code>"+"</code> is given, just
like <code>"*"</code>, all command line arguments present are gathered into a
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>. Additionally, an error message will be generated
if there wasn't at least one command line argument present. If
<code>"?"</code> is given, one argument will be consumed from the command line
if possible, and produced as a single item. If no command line argument
is present, the value from <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setDefault(java.lang.Object)"><code>setDefault(Object)</code></a> will be produced.
Note that for optional arguments, there is an additional case - the
option string is present but not followed by a command line argument. In
this case the value from <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setConst(java.lang.Object)"><code>setConst(Object)</code></a> will be produced.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - <code>"*"</code>, <code>"+"</code> or <code>"?"</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="setConst(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConst</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> setConst(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre>
<div class="block"><p>
Sets constant values that are not read from the command line but are
required for the various actions.
</p>
<p>
The const value defauls to <code>null</code>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The const value</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="setConst(java.lang.Object[])">
<!-- -->
</a><a name="setConst(E...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConst</h4>
<pre><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> setConst(E... values)</pre>
<div class="block"><p>
Sets list of constant values that are not read from the command line but
are required for the various actions.
</p>
<p>
The given <code>values</code> will be converted to <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>. The const
value defauls to <code>null</code>. If you want to set non-List item, use
<a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setConst(java.lang.Object)"><code>setConst(Object)</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - The const values</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="setDefault(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefault</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> setDefault(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre>
<div class="block"><p>
Sets value which should be used if the command line argument is not
present.
</p>
<p>
The default value defaults to <code>null</code>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The default value</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="setDefault(java.lang.Object[])">
<!-- -->
</a><a name="setDefault(E...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefault</h4>
<pre><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> setDefault(E... values)</pre>
<div class="block"><p>
Sets list of values which should be used if the command line argument is
not present.
</p>
<p>
The default value defaults to <code>null</code>. The given <code>values</code> will
be converted to <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>. If you want to set non-List item, use
<a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#setDefault(java.lang.Object)"><code>setDefault(Object)</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - The default values</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="setDefault(net.sourceforge.argparse4j.inf.FeatureControl)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefault</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> setDefault(<a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a> ctrl)</pre>
<div class="block"><p>
Sets special value to control default value handling.
</p>
<p>
Currently, only <a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html#SUPPRESS"><code>FeatureControl.SUPPRESS</code></a> is available. If it is
given, default value is not add as a attribute.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctrl</code> - The special value to control default value handling.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="type(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre><T> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> type(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</pre>
<div class="block"><p>
Sets the type which the command line argument should be converted to.
</p>
<p>
By default, type is String, which means no conversion is made. The type
must have a constructor which takes one String argument.
</p>
<p>
As a convenience, if one of following primitive types (boolean.class,
byte.class, short.class, int.class, long.class, float.class and
double.class) is specified, it is converted to its wrapped type
counterpart. For example, if int.class is given, it is silently converted
to Integer.class.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type which the command line argument should be converted
to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="type(net.sourceforge.argparse4j.inf.ArgumentType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre><T> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> type(<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentType.html" title="interface in net.sourceforge.argparse4j.inf">ArgumentType</a><T> type)</pre>
<div class="block"><p>
Sets <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentType.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentType</code></a> object which converts command line argument to
appropriate type.
</p>
<p>
This would be useful if you need to convert the command line argument
into a type which does not have a constructor with one String argument.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentType.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentType</code></a> object</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="required(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>required</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> required(boolean required)</pre>
<div class="block"><p>
If <code>true</code> is given, this optional argument must be specified in
command line otherwise error will be issued.
</p>
<p>
The default value is <code>false</code>. This object is a positional argument,
this property is ignored.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>required</code> - <code>true</code> or <code>false</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="action(net.sourceforge.argparse4j.inf.ArgumentAction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>action</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> action(<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentAction.html" title="interface in net.sourceforge.argparse4j.inf">ArgumentAction</a> action)</pre>
<div class="block">Sets the action to be taken when this argument is encountered at the
command line.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>action</code> - <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentAction.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentAction</code></a> object</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="choices(net.sourceforge.argparse4j.inf.ArgumentChoice)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>choices</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> choices(<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentChoice.html" title="interface in net.sourceforge.argparse4j.inf">ArgumentChoice</a> choice)</pre>
<div class="block"><p>
Sets <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentChoice.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentChoice</code></a> object which inspects value so that it
fulfills its criteria.
</p>
<p>
This method is useful if more complex inspection is necessary than basic
<a href="../../../../net/sourceforge/argparse4j/inf/Argument.html#choices(E...)"><code>choices(Object...)</code></a>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>choice</code> - <a href="../../../../net/sourceforge/argparse4j/inf/ArgumentChoice.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentChoice</code></a> object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="choices(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>choices</h4>
<pre><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> choices(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><E> values)</pre>
<div class="block">Sets a collection of the allowable values for the argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - A collection of the allowable values</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="choices(java.lang.Object[])">
<!-- -->
</a><a name="choices(E...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>choices</h4>
<pre><E> <a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> choices(E... values)</pre>
<div class="block">Sets a collection of the allowable values for the argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - A collection of the allowable values</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="dest(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dest</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> dest(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dest)</pre>
<div class="block"><p>
The name of the attribute to be added.
</p>
<p>
The default value is For positional arguments, The default value is
normally supplied as the first argument to
<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentParser.html#parseArgs(java.lang.String[])"><code>ArgumentParser.parseArgs(String[])</code></a>. For optional arguments,
<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentParser.html" title="interface in net.sourceforge.argparse4j.inf"><code>ArgumentParser</code></a> generates the default value of <code>dest</code> by
taking the first long option string and stripping away the initial
<code>--</code> string. If no long option strings were supplied, <code>dest</code>
will be derived from the first short option string by stripping the
initial <code>-</code> character. Any internal <code>-</code> characters will be
converted to <code>_</code>.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - The name of the attribute to be added</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="metavar(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metavar</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> metavar(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... metavar)</pre>
<div class="block">Set the name for the argument in usage messages.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>metavar</code> - The name for the argument in usage messages</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="help(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> help(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> help)</pre>
<div class="block">Sets the brief description of what the argument does.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>help</code> - The brief description of what the argument does</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="help(net.sourceforge.argparse4j.inf.FeatureControl)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/Argument.html" title="interface in net.sourceforge.argparse4j.inf">Argument</a> help(<a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a> ctrl)</pre>
<div class="block"><p>
Sets special value to control help message handling.
</p>
<p>
Currently, only <a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html#SUPPRESS"><code>FeatureControl.SUPPRESS</code></a> is available. If it is
given, the help entry for this option is not displayed in the help
message.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctrl</code> - The special value to control help message handling.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this</dd></dl>
</li>
</ul>
<a name="textualName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>textualName</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> textualName()</pre>
<div class="block"><p>
Returns textual representation of the argument name.
</p>
<p>
For optional arguments, this method returns the first argument given in
<a href="../../../../net/sourceforge/argparse4j/inf/ArgumentParser.html#addArgument(java.lang.String...)"><code>ArgumentParser.addArgument(String...)</code></a>. For positional arguments,
this method returns the flags joined with "/", e.g. <code>-f/--foo</code>.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The textual representation of the argument name.</dd></dl>
</li>
</ul>
<a name="getDest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDest</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDest()</pre>
<div class="block">Returns dest value.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The dest value</dd></dl>
</li>
</ul>
<a name="getConst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConst</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getConst()</pre>
<div class="block">Returns const value.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The const value</dd></dl>
</li>
</ul>
<a name="getDefault()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getDefault()</pre>
<div class="block">Returns default value.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The default value</dd></dl>
</li>
</ul>
<a name="getDefaultControl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultControl</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a> getDefaultControl()</pre>
<div class="block">Returns default control.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The default control</dd></dl>
</li>
</ul>
<a name="getHelpControl()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHelpControl</h4>
<pre><a href="../../../../net/sourceforge/argparse4j/inf/FeatureControl.html" title="enum in net.sourceforge.argparse4j.inf">FeatureControl</a> getHelpControl()</pre>
<div class="block">Returns help control.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The help control</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Argument.html">Use</a></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>Prev Class</li>
<li><a href="../../../../net/sourceforge/argparse4j/inf/ArgumentAction.html" title="interface in net.sourceforge.argparse4j.inf"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?net/sourceforge/argparse4j/inf/Argument.html" target="_top">Frames</a></li>
<li><a href="Argument.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>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2012–2015. All rights reserved.</small></p>
</body>
</html>
|