/usr/share/doc/libjsap-java/api/com/martiansoftware/jsap/Option.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 | <!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>Option (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="Option (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":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/Option.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/JSAPResult.html" title="class in com.martiansoftware.jsap"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/martiansoftware/jsap/Parameter.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/Option.html" target="_top">Frames</a></li>
<li><a href="Option.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 Option" class="title">Class Option</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><a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">com.martiansoftware.jsap.Parameter</a></li>
<li>
<ul class="inheritance">
<li>com.martiansoftware.jsap.Option</li>
</ul>
</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/FlaggedOption.html" title="class in com.martiansoftware.jsap">FlaggedOption</a>, <a href="../../../com/martiansoftware/jsap/UnflaggedOption.html" title="class in com.martiansoftware.jsap">UnflaggedOption</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Option</span>
extends <a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</a></pre>
<div class="block">The base class from which FlaggedOption and UnflaggedOption are derived.
An Option is a Parameter
that requires some information (unlike a Switch whose mere presence is
significant).<br>
<br>
Options may be declared as lists, or multiple values separated by a
delimiting character. An example of
a list option might be a classpath, which is a collection of paths separated
by a ":" on *nix systems and
a ";" on DOS/Windows systems. JSAP automatically separates list options
into multiple tokens before calling
their StringParsers' parse() method.
<p>The default list separator is JSAP.DEFAULT_LISTSEPARATOR, which is defined
as the platform's path separator
character (":" on *nix and ";" on DOS/Windows as described above).</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/Flagged.html" title="interface in com.martiansoftware.jsap"><code>Flagged</code></a>,
<a href="../../../com/martiansoftware/jsap/Option.html" title="class in com.martiansoftware.jsap"><code>Option</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/Option.html#Option-java.lang.String-">Option</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 Option with the specified unique ID.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#getListSeparator--">getListSeparator</a></span>()</code>
<div class="block">Returns the current list separator character for this Option.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap">StringParser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#getStringParser--">getStringParser</a></span>()</code>
<div class="block">Returns the StringParser to which this Option will delegate calls to its
parse() method, or null if
no StringParser is currently defined.</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/Option.html#internalSetList-boolean-">internalSetList</a></span>(boolean isList)</code>
<div class="block">Sets whether this Option is a list.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#internalSetListSeparator-char-">internalSetListSeparator</a></span>(char listSeparator)</code>
<div class="block">Sets the list separator character for this Option.</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/Option.html#internalSetRequired-boolean-">internalSetRequired</a></span>(boolean required)</code>
<div class="block">Sets whether this Option is required.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#internalSetStringParser-com.martiansoftware.jsap.StringParser-">internalSetStringParser</a></span>(<a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap">StringParser</a> stringParser)</code>
<div class="block">Sets the StringParser to which this Option's parse() method should
delegate.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#isList--">isList</a></span>()</code>
<div class="block">Returns a boolean indicating whether this Option is a list.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <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/Option.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">Parses the specified argument, returning the results in an ArrayList.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#register--">register</a></span>()</code>
<div class="block">Informs this Option's StringParser that this Option is being registered
with a JSAP.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#required--">required</a></span>()</code>
<div class="block">Returns a boolean indicating whether this Option is required.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/martiansoftware/jsap/Option.html#unregister--">unregister</a></span>()</code>
<div class="block">Informs this Option's StringParser that this Option is being
unregistered
from a JSAP.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.martiansoftware.jsap.Parameter">
<!-- -->
</a>
<h3>Methods inherited from class com.martiansoftware.jsap.<a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</a></h3>
<code><a href="../../../com/martiansoftware/jsap/Parameter.html#Z:Z_setDefault-java.lang.String-">_setDefault</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#Z:Z_setDefault-java.lang.String:A-">_setDefault</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#Z:Z_setUsageName-java.lang.String-">_setUsageName</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#addDefault-java.lang.String-">addDefault</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#enforceParameterLock--">enforceParameterLock</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#getDefault--">getDefault</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#getHelp--">getHelp</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#getID--">getID</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#getSyntax--">getSyntax</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#getUsage--">getUsage</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#getUsageName--">getUsageName</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#locked--">locked</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#setHelp-java.lang.String-">setHelp</a>, <a href="../../../com/martiansoftware/jsap/Parameter.html#setLocked-boolean-">setLocked</a></code></li>
</ul>
<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="Option-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Option</h4>
<pre>public Option(<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 Option with the specified unique ID.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the unique ID for this Option.</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="internalSetList-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>internalSetList</h4>
<pre>protected final void internalSetList(boolean isList)</pre>
<div class="block">Sets whether this Option is a list. Default behavior is JSAP.NOT_LIST.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isList</code> - if true, this Option is a list.</dd>
</dl>
</li>
</ul>
<a name="isList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isList</h4>
<pre>public final boolean isList()</pre>
<div class="block">Returns a boolean indicating whether this Option is a list.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean indicating whether this Option is a list.</dd>
</dl>
</li>
</ul>
<a name="internalSetListSeparator-char-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>internalSetListSeparator</h4>
<pre>protected final void internalSetListSeparator(char listSeparator)</pre>
<div class="block">Sets the list separator character for this Option. The default list
separator is JSAP.DEFAULT_LISTSEPARATOR.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listSeparator</code> - the list separator for this Option.</dd>
</dl>
</li>
</ul>
<a name="getListSeparator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListSeparator</h4>
<pre>public final char getListSeparator()</pre>
<div class="block">Returns the current list separator character for this Option.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current list separator character for this Option.</dd>
</dl>
</li>
</ul>
<a name="internalSetRequired-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>internalSetRequired</h4>
<pre>protected final void internalSetRequired(boolean required)</pre>
<div class="block">Sets whether this Option is required. Default is JSAP.NOT_REQUIRED.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>required</code> - if true, this Option will be required.</dd>
</dl>
</li>
</ul>
<a name="required--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>required</h4>
<pre>public final boolean required()</pre>
<div class="block">Returns a boolean indicating whether this Option is required.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean indicating whether this Option is required.</dd>
</dl>
</li>
</ul>
<a name="internalSetStringParser-com.martiansoftware.jsap.StringParser-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>internalSetStringParser</h4>
<pre>protected final void internalSetStringParser(<a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap">StringParser</a> stringParser)</pre>
<div class="block">Sets the StringParser to which this Option's parse() method should
delegate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stringParser</code> - the StringParser to which this Option's parse()
method should delegate.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap"><code>StringParser</code></a></dd>
</dl>
</li>
</ul>
<a name="getStringParser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringParser</h4>
<pre>public final <a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap">StringParser</a> getStringParser()</pre>
<div class="block">Returns the StringParser to which this Option will delegate calls to its
parse() method, or null if
no StringParser is currently defined.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the StringParser to which this Option will delegate calls to its
parse() method, or null if
no StringParser is currently defined.</dd>
</dl>
</li>
</ul>
<a name="parse-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>protected final <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">Parses the specified argument, returning the results in an ArrayList.
List options are tokenized
before the parse call is delegated to the StringParser.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/martiansoftware/jsap/Parameter.html#parse-java.lang.String-">parse</a></code> in class <code><a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</a></code></dd>
<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 objects 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 (or one of its tokens,
in the case of a list) cannot
be parsed.</dd>
</dl>
</li>
</ul>
<a name="register--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre>protected void register()
throws <a href="../../../com/martiansoftware/jsap/JSAPException.html" title="class in com.martiansoftware.jsap">JSAPException</a></pre>
<div class="block">Informs this Option's StringParser that this Option is being registered
with a JSAP. If the StringParser requires any setup not taken care of
in its constructor, it should override StringParser.setUp().</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/martiansoftware/jsap/JSAPException.html" title="class in com.martiansoftware.jsap">JSAPException</a></code> - if the underlying StringParser throws it.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/martiansoftware/jsap/StringParser.html#setUp--"><code>StringParser.setUp()</code></a></dd>
</dl>
</li>
</ul>
<a name="unregister--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unregister</h4>
<pre>protected void unregister()</pre>
<div class="block">Informs this Option's StringParser that this Option is being
unregistered
from a JSAP. If the StringParser requires any cleanup, it should
ovverride
StringParser.tearDown().</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/martiansoftware/jsap/StringParser.html#tearDown--"><code>StringParser.tearDown()</code></a></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/Option.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/JSAPResult.html" title="class in com.martiansoftware.jsap"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/martiansoftware/jsap/Parameter.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/Option.html" target="_top">Frames</a></li>
<li><a href="Option.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>
|