/usr/share/doc/starlink-task-java-doc/api/uk/ac/starlink/task/ChoiceParameter.html is in starlink-task-java-doc 0.2+2016.05.03-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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>ChoiceParameter (Starjava Task API)</title>
<meta name="date" content="2017-04-10">
<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="ChoiceParameter (Starjava Task 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,"i11":10,"i12":10,"i13":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="../../../../uk/ac/starlink/task/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/task/ChoiceParameter.html" target="_top">Frames</a></li>
<li><a href="ChoiceParameter.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><a href="#fields.inherited.from.class.uk.ac.starlink.task.Parameter">Field</a> | </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">uk.ac.starlink.task</div>
<h2 title="Class ChoiceParameter" class="title">Class ChoiceParameter<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">uk.ac.starlink.task.Parameter</a><T></li>
<li>
<ul class="inheritance">
<li>uk.ac.starlink.task.ChoiceParameter<T></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ChoiceParameter<T></span>
extends <a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><T></pre>
<div class="block">Parameter whose legal value must be one of a disjunction of given values.
Matching is case-insensitive against the stringified value of the option.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>15 Aug 2005</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Taylor</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.uk.ac.starlink.task.Parameter">
<!-- -->
</a>
<h3>Fields inherited from class uk.ac.starlink.task.<a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></h3>
<code><a href="../../../../uk/ac/starlink/task/Parameter.html#BY_NAME">BY_NAME</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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="../../../../uk/ac/starlink/task/ChoiceParameter.html#ChoiceParameter-java.lang.String-java.lang.Class-">ChoiceParameter</a></span>(java.lang.String name,
java.lang.Class<<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>> clazz)</code>
<div class="block">Constructs a choice parameter with no initially set options.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#ChoiceParameter-java.lang.String-java.lang.Class-T:A-">ChoiceParameter</a></span>(java.lang.String name,
java.lang.Class<<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>> clazz,
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>[] options)</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#ChoiceParameter-java.lang.String-T:A-">ChoiceParameter</a></span>(java.lang.String name,
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>[] options)</code>
<div class="block">Constructs a choice parameter with an initial option set.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#addOption-T-">addOption</a></span>(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</code>
<div class="block">Adds an option value to this parameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#addOption-T-java.lang.String-">addOption</a></span>(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option,
java.lang.String name)</code>
<div class="block">Adds an option value to this parameter with a given name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#clearOptions--">clearOptions</a></span>()</code>
<div class="block">Clears the list of known options.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#getName-T-">getName</a></span>(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</code>
<div class="block">Converts an option value object to a string which is used to identify
it as a string value of this parameter.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#getOption-java.lang.String-">getOption</a></span>(java.lang.String name)</code>
<div class="block">Returns the option value associated with a given string by this
parameter.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#getOptionNames--">getOptionNames</a></span>()</code>
<div class="block">Returns an array of the string values of options accepted by this
parameter.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#getOptions--">getOptions</a></span>()</code>
<div class="block">Returns an array of the option objects which may form the
values of this parameter.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Collection<<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#getOptionValueList--">getOptionValueList</a></span>()</code>
<div class="block">Returns a collection of the option objects which may form the
values of this parameter.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#getUsage--">getUsage</a></span>()</code>
<div class="block">Returns a usage message.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#objectToString-uk.ac.starlink.task.Environment-T-">objectToString</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> objVal)</code>
<div class="block">Takes a typed value of this parameter and formats it as a string
which may be used for presentation to the user.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#setDefaultOption-T-">setDefaultOption</a></span>(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</code>
<div class="block">Sets the default value for this parameter to one of the previously
added options.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#setUsage-java.lang.String-">setUsage</a></span>(java.lang.String usage)</code>
<div class="block">Sets a usage string for this parameter.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#stringifyOption-T-">stringifyOption</a></span>(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</code>
<div class="block">Determines how an option will be represented as a string value of
this parameter if no name has explicitly been supplied.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
java.lang.String sval)</code>
<div class="block">Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.uk.ac.starlink.task.Parameter">
<!-- -->
</a>
<h3>Methods inherited from class uk.ac.starlink.task.<a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></h3>
<code><a href="../../../../uk/ac/starlink/task/Parameter.html#clearValue-uk.ac.starlink.task.Environment-">clearValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getDescription--">getDescription</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getName--">getName</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getPosition--">getPosition</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getPreferExplicit--">getPreferExplicit</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getPrompt--">getPrompt</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getStringDefault--">getStringDefault</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getValueClass--">getValueClass</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#isNullPermitted--">isNullPermitted</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#objectValue-uk.ac.starlink.task.Environment-">objectValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String:A-">setDescription</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setName-java.lang.String-">setName</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setNullPermitted-boolean-">setNullPermitted</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setPosition-int-">setPosition</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setPreferExplicit-boolean-">setPreferExplicit</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setPrompt-java.lang.String-">setPrompt</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setStringDefault-java.lang.String-">setStringDefault</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setValue-java.lang.String-T-">setValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setValueFromObject-uk.ac.starlink.task.Environment-T-">setValueFromObject</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setValueFromString-uk.ac.starlink.task.Environment-java.lang.String-">setValueFromString</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#stringValue-uk.ac.starlink.task.Environment-">stringValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#toArray-java.util.Collection-">toArray</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#toString--">toString</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="ChoiceParameter-java.lang.String-java.lang.Class-java.lang.Object:A-">
<!-- -->
</a><a name="ChoiceParameter-java.lang.String-java.lang.Class-T:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ChoiceParameter</h4>
<pre>public ChoiceParameter(java.lang.String name,
java.lang.Class<<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>> clazz,
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>[] options)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - parameter name</dd>
<dd><code>clazz</code> - type for values of this parameter</dd>
<dd><code>options</code> - initial array of legal values of this parameter</dd>
</dl>
</li>
</ul>
<a name="ChoiceParameter-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ChoiceParameter</h4>
<pre>public ChoiceParameter(java.lang.String name,
java.lang.Class<<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>> clazz)</pre>
<div class="block">Constructs a choice parameter with no initially set options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - parameter name</dd>
<dd><code>clazz</code> - type for values of this parameter</dd>
</dl>
</li>
</ul>
<a name="ChoiceParameter-java.lang.String-java.lang.Object:A-">
<!-- -->
</a><a name="ChoiceParameter-java.lang.String-T:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ChoiceParameter</h4>
<pre>public ChoiceParameter(java.lang.String name,
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>[] options)</pre>
<div class="block">Constructs a choice parameter with an initial option set.
The data type is taken from the supplied array type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - parameter name</dd>
<dd><code>options</code> - initial array of legal values of this parameter</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="stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringToObject</h4>
<pre>public <a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> stringToObject(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
java.lang.String sval)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">Parameter</a></code></span></div>
<div class="block">Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.
This method also performs validation, so if the string value
is unacceptable in any way, a ParameterValueException should
be thrown.
<p>It is an error to supply a null or empty string value.
<p>If this method fails (throws a ParameterValueException)
and if <code>allowClassnameValue</code> is set, then a subsequent
attempt will be made to interpret the <code>stringVal</code>
as the classname of a suitable class with a no-arg constructor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject</a></code> in class <code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the result</dd>
<dd><code>sval</code> - non-null, non-empty string value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>typed value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></code></dd>
</dl>
</li>
</ul>
<a name="objectToString-uk.ac.starlink.task.Environment-java.lang.Object-">
<!-- -->
</a><a name="objectToString-uk.ac.starlink.task.Environment-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>objectToString</h4>
<pre>public java.lang.String objectToString(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> objVal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../uk/ac/starlink/task/Parameter.html#objectToString-uk.ac.starlink.task.Environment-T-">Parameter</a></code></span></div>
<div class="block">Takes a typed value of this parameter and formats it as a string
which may be used for presentation to the user.
Ideally, round-tripping between this method and
<a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-"><code>stringToObject</code></a> should be possible,
but that is not in general required/guaranteed.
<p>The default implementation uses the value's toString method,
but subclasses can override this for smarter behaviour.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/Parameter.html#objectToString-uk.ac.starlink.task.Environment-T-">objectToString</a></code> in class <code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment</dd>
<dd><code>objVal</code> - typed parameter value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string value for presentation</dd>
</dl>
</li>
</ul>
<a name="addOption-java.lang.Object-java.lang.String-">
<!-- -->
</a><a name="addOption-T-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOption</h4>
<pre>public void addOption(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option,
java.lang.String name)</pre>
<div class="block">Adds an option value to this parameter with a given name.
The name is the parameter value string used to identify this option.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>option</code> - option object</dd>
<dd><code>name</code> - label for option</dd>
</dl>
</li>
</ul>
<a name="addOption-java.lang.Object-">
<!-- -->
</a><a name="addOption-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOption</h4>
<pre>public void addOption(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</pre>
<div class="block">Adds an option value to this parameter.
The option's name will be determined by this object's
<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#stringifyOption-T-"><code>stringifyOption(T)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>option</code> - option object</dd>
</dl>
</li>
</ul>
<a name="clearOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearOptions</h4>
<pre>public void clearOptions()</pre>
<div class="block">Clears the list of known options.</div>
</li>
</ul>
<a name="getUsage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsage</h4>
<pre>public java.lang.String getUsage()</pre>
<div class="block">Returns a usage message. Unless it has been overriden by an earlier
call to <a href="../../../../uk/ac/starlink/task/ChoiceParameter.html#setUsage-java.lang.String-"><code>setUsage(java.lang.String)</code></a>, this will return a usage message based on
the list of known options.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/Parameter.html#getUsage--">getUsage</a></code> in class <code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>usage message</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../uk/ac/starlink/task/Parameter.html#setUsage-java.lang.String-"><code>Parameter.setUsage(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setUsage-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsage</h4>
<pre>public void setUsage(java.lang.String usage)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../uk/ac/starlink/task/Parameter.html#setUsage-java.lang.String-">Parameter</a></code></span></div>
<div class="block">Sets a usage string for this parameter. This should be terse
(in particular no newline characters) and conform to the
following rules:
<ul>
<li>the parameter name is not included in the message
<li>placeholders are enclosed in angle brackets (<>)
<li>literals are not enclosed in angle brackets
<li>a disjunction is represented using the "|" character
</ul>
The <code>Parameter</code> class uses the string "<value>"
as the default usage string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/Parameter.html#setUsage-java.lang.String-">setUsage</a></code> in class <code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>usage</code> - usage string</dd>
</dl>
</li>
</ul>
<a name="setDefaultOption-java.lang.Object-">
<!-- -->
</a><a name="setDefaultOption-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultOption</h4>
<pre>public void setDefaultOption(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</pre>
<div class="block">Sets the default value for this parameter to one of the previously
added options.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>option</code> - default option</dd>
</dl>
</li>
</ul>
<a name="getOptionNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptionNames</h4>
<pre>public java.lang.String[] getOptionNames()</pre>
<div class="block">Returns an array of the string values of options accepted by this
parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>permitted options, stringified</dd>
</dl>
</li>
</ul>
<a name="getOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptions</h4>
<pre>public <a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>[] getOptions()</pre>
<div class="block">Returns an array of the option objects which may form the
values of this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>permitted options</dd>
</dl>
</li>
</ul>
<a name="getOptionValueList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOptionValueList</h4>
<pre>public java.util.Collection<<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>> getOptionValueList()</pre>
<div class="block">Returns a collection of the option objects which may form the
values of this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>permitted options</dd>
</dl>
</li>
</ul>
<a name="getName-java.lang.Object-">
<!-- -->
</a><a name="getName-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</pre>
<div class="block">Converts an option value object to a string which is used to identify
it as a string value of this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>option</code> - option value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string representation</dd>
</dl>
</li>
</ul>
<a name="stringifyOption-java.lang.Object-">
<!-- -->
</a><a name="stringifyOption-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringifyOption</h4>
<pre>public java.lang.String stringifyOption(<a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> option)</pre>
<div class="block">Determines how an option will be represented as a string value of
this parameter if no name has explicitly been supplied.
The default implementation is <code>String.valueOf(option)</code>,
but this may be overrridden.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>option</code> - option value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string representation of option</dd>
</dl>
</li>
</ul>
<a name="getOption-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOption</h4>
<pre>public <a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a> getOption(java.lang.String name)</pre>
<div class="block">Returns the option value associated with a given string by this
parameter. Null is returned if none of the options added so far
has a name as supplied. Name matching is case-insensitive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of option which has been added</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>correspondig option object</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="../../../../uk/ac/starlink/task/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/task/ChoiceParameter.html" target="_top">Frames</a></li>
<li><a href="ChoiceParameter.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><a href="#fields.inherited.from.class.uk.ac.starlink.task.Parameter">Field</a> | </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><i>Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.<i></small></p>
</body>
</html>
|