/usr/share/doc/libjsap-java/api/com/martiansoftware/jsap/Parameter.html is in libjsap-java-doc 2.1-3.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Parameter (JSAP 2.1 API)</title>
<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 (JSAP 2.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":42,"i10":10,"i11":10,"i12":6,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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="class-use/Parameter.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><a href="../../../com/martiansoftware/jsap/Option.html" title="class in com.martiansoftware.jsap"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/martiansoftware/jsap/ParseException.html" title="class in com.martiansoftware.jsap"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/martiansoftware/jsap/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>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">com.martiansoftware.jsap</div>
<h2 title="Class Parameter" class="title">Class Parameter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.martiansoftware.jsap.Parameter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/martiansoftware/jsap/Option.html" title="class in com.martiansoftware.jsap">Option</a>, <a href="../../../com/martiansoftware/jsap/Switch.html" title="class in com.martiansoftware.jsap">Switch</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Parameter</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>Top-level abstraction of a <b>parameter</b>. A <b>parameter</b> consists
of one or more <b>arguments</b> (command line tokens) that have a special
meaning when taken together.
For example, a command-line switch "-v" is a parameter consisting of a single
argument, whereas a command-line option "--file somefile.txt" is a parameter
consisting of two arguments. Some parameters can be quite large, such as an
option for a file compression utility that allows you to specify any number
of files to comporess.</p>
<p>This is an abstract class. See its subclasses <a href="../../../com/martiansoftware/jsap/Switch.html" title="class in com.martiansoftware.jsap"><code>Switch</code></a>,
<a href="../../../com/martiansoftware/jsap/FlaggedOption.html" title="class in com.martiansoftware.jsap"><code>FlaggedOption</code></a>, and <a href="../../../com/martiansoftware/jsap/UnflaggedOption.html" title="class in com.martiansoftware.jsap"><code>UnflaggedOption</code></a>
for details on the various types of parameters. Functionality common to all three
types of Parameters is described below.</p>
<p>Each parameter has a unique ID assigned in its constructor. This ID is
used to retrieve values from the parser after the command line is parsed.
You can set the ID to any String value you wish, although in general you'll
want them to be brief and descriptive to provide a degree of documentation.
A "-h" switch, for example, might have the ID "help".
The calling program can then determine if the user specified the -h switch on
the command line with the simple call <code>getBoolean("help")</code> against
the JSAPResult object produced by JSAP.parse().</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="http://www.martiansoftware.com/contact.html">Marty Lamb</a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/martiansoftware/jsap/Switch.html" title="class in com.martiansoftware.jsap"><code>Switch</code></a>,
<a href="../../../com/martiansoftware/jsap/FlaggedOption.html" title="class in com.martiansoftware.jsap"><code>FlaggedOption</code></a>,
<a href="../../../com/martiansoftware/jsap/UnflaggedOption.html" title="class in com.martiansoftware.jsap"><code>UnflaggedOption</code></a>,
<a href="../../../com/martiansoftware/jsap/JSAPResult.html#getBoolean-java.lang.String-"><code>JSAPResult.getBoolean(String)</code></a>,
<a href="../../../com/martiansoftware/jsap/JSAP.html#parse-java.lang.String:A-"><code>JSAP.parse(String[])</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#Parameter-java.lang.String-">Parameter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code>
<div class="block">Creates a new Parameter.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#Z:Z_setDefault-java.lang.String-">_setDefault</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code>
<div class="block">Sets a default value for this parameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#Z:Z_setDefault-java.lang.String:A-">_setDefault</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] defaultValues)</code>
<div class="block">Sets one or more default values for this parameter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#Z:Z_setUsageName-java.lang.String-">_setUsageName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usageName)</code>
<div class="block">Sets the name of this AbstractParameter for the purposes of
usage information.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#addDefault-java.lang.String-">addDefault</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</code>
<div class="block">Adds a single default value to any currently defined for this
parameter.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#enforceParameterLock--">enforceParameterLock</a></span>()</code>
<div class="block">Helper method that can be called by any methods that modify this
parameter (or its subclasses).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#getDefault--">getDefault</a></span>()</code>
<div class="block">Returns an array of default values for this parameter, or
null if no default values have been defined.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#getHelp--">getHelp</a></span>()</code>
<div class="block">Returns a description of the option's usage.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#getID--">getID</a></span>()</code>
<div class="block">Returns this parameter's unique ID.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#getSyntax--">getSyntax</a></span>()</code>
<div class="block">A convenience method for automatically generating syntax
information based upon a JSAP configuration.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#getUsage--">getUsage</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">use getSyntax() instead</span></div>
</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#getUsageName--">getUsageName</a></span>()</code>
<div class="block">Returns the name of this AbstractParameter for the purposes of
usage information.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#locked--">locked</a></span>()</code>
<div class="block">Returns a boolean indicating whether this parameter is locked.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#parse-java.lang.String-">parse</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> arg)</code>
<div class="block">Returns an ArrayList of values resulting from the parsing
of the specified argument.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#setHelp-java.lang.String-">setHelp</a></span>(<a href="http://docs.oracle.com/javase/8/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 help text for this parameter.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Parameter.html#setLocked-boolean-">setLocked</a></span>(boolean locked)</code>
<div class="block">Locks or unlocks this parameter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Parameter-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Parameter</h4>
<pre>public Parameter(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</pre>
<div class="block">Creates a new Parameter. Subclasses should call this
constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - The ID for this argument. All arguments MUST have
a unique ID.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getID()</pre>
<div class="block">Returns this parameter's unique ID.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this parameter's unique ID.</dd>
</dl>
</li>
</ul>
<a name="setLocked-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocked</h4>
<pre>protected final void setLocked(boolean locked)</pre>
<div class="block">Locks or unlocks this parameter. Locked parameters cannot be
modified. This is necessary because the JSAP object with
which parameters are registered performs certain validation
routines at the time of registration. See
JSAP.registerParameter(Parameter) for more information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locked</code> - if <code>TRUE</code>, locks this parameter. if
<code>FALSE</code>, unlocks it.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/martiansoftware/jsap/JSAP.html#registerParameter-com.martiansoftware.jsap.Parameter-"><code>JSAP.registerParameter(Parameter)</code></a></dd>
</dl>
</li>
</ul>
<a name="locked--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locked</h4>
<pre>protected final boolean locked()</pre>
<div class="block">Returns a boolean indicating whether this parameter is locked.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean indicating whether this parameter is currently
locked.</dd>
</dl>
</li>
</ul>
<a name="enforceParameterLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enforceParameterLock</h4>
<pre>protected final void enforceParameterLock()</pre>
<div class="block">Helper method that can be called by any methods that modify this
parameter (or its subclasses).
If the parameter is currently locked, an IllegalStateException
is thrown.</div>
</li>
</ul>
<a name="Z:Z_setDefault-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_setDefault</h4>
<pre>protected final void _setDefault(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre>
<div class="block">Sets a default value for this parameter. The default is specified
as a String, and is parsed as a single value specified on the
command line. In other words, default values for "list"
parameters or parameters allowing multiple declarations should be
set using setDefault(String[]), as JSAP
would otherwise treat the entire list of values as a single value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - the default value for this parameter.</dd>
</dl>
</li>
</ul>
<a name="Z:Z_setDefault-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_setDefault</h4>
<pre>protected final void _setDefault(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] defaultValues)</pre>
<div class="block">Sets one or more default values for this parameter. This method
should be used whenever a parameter has more than one default
value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValues</code> - the default values for this parameter.</dd>
</dl>
</li>
</ul>
<a name="addDefault-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDefault</h4>
<pre>public final void addDefault(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultValue)</pre>
<div class="block">Adds a single default value to any currently defined for this
parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>defaultValue</code> - the default value to add to this parameter.</dd>
</dl>
</li>
</ul>
<a name="Z:Z_setUsageName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_setUsageName</h4>
<pre>protected final void _setUsageName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> usageName)</pre>
<div class="block">Sets the name of this AbstractParameter for the purposes of
usage information. If null, the id will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>usageName</code> - the usage name for this AbstractParameter</dd>
</dl>
</li>
</ul>
<a name="getUsageName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsageName</h4>
<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUsageName()</pre>
<div class="block">Returns the name of this AbstractParameter for the purposes of
usage information. The returned value is by default the id of
this parameter, but can be overridden via setUsageName(String).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of this AbstractParameter for the purposes of
usage information.</dd>
</dl>
</li>
</ul>
<a name="getDefault--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getDefault()</pre>
<div class="block">Returns an array of default values for this parameter, or
null if no default values have been defined.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of default values for this parameter, or
null if no default values have been defined.</dd>
</dl>
</li>
</ul>
<a name="parse-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>protected abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> parse(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> arg)
throws <a href="../../../com/martiansoftware/jsap/ParseException.html" title="class in com.martiansoftware.jsap">ParseException</a></pre>
<div class="block">Returns an ArrayList of values resulting from the parsing
of the specified argument. Multiple values may be returned
if the arg is a list (such as a PATH or CLASSPATH variable),
or if the semantics of the parameter type otherwise represent
multiple values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg</code> - the argument to parse.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a List of values resulting from the parse.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/martiansoftware/jsap/ParseException.html" title="class in com.martiansoftware.jsap">ParseException</a></code> - if the specified argument cannot be parsed.</dd>
</dl>
</li>
</ul>
<a name="getSyntax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSyntax</h4>
<pre>public abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSyntax()</pre>
<div class="block">A convenience method for automatically generating syntax
information based upon a JSAP configuration. A call to
JSAP.getSyntax() returns a String built by calling getSyntax() on
every parameter registered to a JSAP in the order in which they
were registered. This method does not provide a help
description (see getHelp()), but rather the syntax for this
parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>usage information for this parameter.</dd>
</dl>
</li>
</ul>
<a name="getUsage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsage</h4>
<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUsage()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use getSyntax() instead</span></div>
<div class="block">Deprecated - use getSyntax()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>deprecated - use getSyntax()</dd>
</dl>
</li>
</ul>
<a name="getHelp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHelp</h4>
<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHelp()</pre>
<div class="block">Returns a description of the option's usage.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a textual description of this option's usage</dd>
</dl>
</li>
</ul>
<a name="setHelp-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setHelp</h4>
<pre>public final <a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</a> setHelp(<a href="http://docs.oracle.com/javase/8/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 help text for this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>help</code> - the help text for this parameter.</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="class-use/Parameter.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><a href="../../../com/martiansoftware/jsap/Option.html" title="class in com.martiansoftware.jsap"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/martiansoftware/jsap/ParseException.html" title="class in com.martiansoftware.jsap"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/martiansoftware/jsap/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>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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 © 2016. All rights reserved.</small></p>
</body>
</html>
|