/usr/share/doc/starlink-task-java-doc/api/uk/ac/starlink/task/Parameter.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 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>Parameter (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="Parameter (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,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":6,"i25":10,"i26":10,"i27":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/OutputStreamParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/task/ParameterValueException.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/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><a href="#field.summary">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><a href="#field.detail">Field</a> | </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 Parameter" class="title">Class Parameter<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>uk.ac.starlink.task.Parameter<T></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task">BooleanParameter</a>, <a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a>, <a href="../../../../uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a>, <a href="../../../../uk/ac/starlink/task/InputStreamParameter.html" title="class in uk.ac.starlink.task">InputStreamParameter</a>, <a href="../../../../uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a>, <a href="../../../../uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a>, <a href="../../../../uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task">ObjectFactoryParameter</a>, <a href="../../../../uk/ac/starlink/task/OutputStreamParameter.html" title="class in uk.ac.starlink.task">OutputStreamParameter</a>, <a href="../../../../uk/ac/starlink/task/StringParameter.html" title="class in uk.ac.starlink.task">StringParameter</a>, <a href="../../../../uk/ac/starlink/task/URLParameter.html" title="class in uk.ac.starlink.task">URLParameter</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Parameter<T></span>
extends java.lang.Object</pre>
<div class="block">A Parameter describes the function of one of a task's parameters.
An instance of the class encapsulates a parameter's name, value type,
prompt string, default value, position on the command line,
and so on. It can also validate, hold and clear the value of the
parameter. The parameter value is acquired from an associated
Environment in either String or typed form, and the Parameter
object configures its value from that.
<p>
This class must be subclassed according to the type of values it obtains.
Such concrete subclasses must implement the <a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-"><code>stringToObject(uk.ac.starlink.task.Environment, java.lang.String)</code></a>
method to perform mapping from an environment-supplied string value
to a typed parameter value, including validation.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Taylor (Starlink)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task"><code>Task</code></a>,
<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task"><code>Environment</code></a></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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#BY_NAME">BY_NAME</a></span></code>
<div class="block">Compares parameters alphabetically by parameter name.</div>
</td>
</tr>
</table>
</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/Parameter.html#Parameter-java.lang.String-java.lang.Class-boolean-">Parameter</a></span>(java.lang.String name,
java.lang.Class<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>> clazz,
boolean allowClassnameValue)</code>
<div class="block">Constructs a parameter with a given name.</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></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/Parameter.html#clearValue-uk.ac.starlink.task.Environment-">clearValue</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)</code>
<div class="block">Clears the value of this parameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the textual description for this parameter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of this parameter.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getPosition--">getPosition</a></span>()</code>
<div class="block">Gets the position of this parameter in a parameter list;
the first parameter is 1.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getPreferExplicit--">getPreferExplicit</a></span>()</code>
<div class="block">Determine whether an explict value is generally preferred to the
default value for 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/Parameter.html#getPrompt--">getPrompt</a></span>()</code>
<div class="block">Gets the prompt string for this parameter, as displayed to the
user when the value of the parameter is requested.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getStringDefault--">getStringDefault</a></span>()</code>
<div class="block">Gets the default string value for this parameter.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getUsage--">getUsage</a></span>()</code>
<div class="block">Returns the usage string for this parameter.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.Class<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#getValueClass--">getValueClass</a></span>()</code>
<div class="block">Returns the class of the typed values this parameter takes.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#isNullPermitted--">isNullPermitted</a></span>()</code>
<div class="block">Determine whether it is legal for this parameter's value to be blank.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.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/Parameter.html" title="type parameter in Parameter">T</a> objectVal)</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="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#objectValue-uk.ac.starlink.task.Environment-">objectValue</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)</code>
<div class="block">Gets the value of this parameter as a typed object.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String description)</code>
<div class="block">Sets the textual description for this parameter.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String:A-">setDescription</a></span>(java.lang.String[] descLines)</code>
<div class="block">Convenience method to set the description for this parameter by
the result of joining an array of lines together.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code>
<div class="block">Sets the name of this parameter.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setNullPermitted-boolean-">setNullPermitted</a></span>(boolean permitted)</code>
<div class="block">Set whether it is legal for this parameter's value to be blank.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setPosition-int-">setPosition</a></span>(int pos)</code>
<div class="block">Sets the position of this parameter in a parameter list;
the first parameter is 1.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setPreferExplicit-boolean-">setPreferExplicit</a></span>(boolean prefer)</code>
<div class="block">Set whether an explicit value is generally to be solicited from
the user rather than taking the default.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setPrompt-java.lang.String-">setPrompt</a></span>(java.lang.String prompt)</code>
<div class="block">Sets the prompt string for this parameter, as displayed to the
user when the value of the parameter is requested.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setStringDefault-java.lang.String-">setStringDefault</a></span>(java.lang.String stringDflt)</code>
<div class="block">Sets the default string value for this parameter.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.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="i21" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setValue-java.lang.String-T-">setValue</a></span>(java.lang.String stringValue,
<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a> objectValue)</code>
<div class="block">Sets the value of this parameter without any additional validation.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setValueFromObject-uk.ac.starlink.task.Environment-T-">setValueFromObject</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/Parameter.html" title="type parameter in Parameter">T</a> objectValue)</code>
<div class="block">Sets the value of this parameter directly from a typed object.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#setValueFromString-uk.ac.starlink.task.Environment-java.lang.String-">setValueFromString</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
java.lang.String stringval)</code>
<div class="block">Sets the value of this parameter from a String.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.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 stringVal)</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>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#stringValue-uk.ac.starlink.task.Environment-">stringValue</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)</code>
<div class="block">Gets the value of this parameter as a String.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#toArray-java.util.Collection-">toArray</a></span>(java.util.Collection<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>> collection)</code>
<div class="block">Utility function to convert a list to an array, where the elements
are of the value class of this parameter.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/Parameter.html#toString--">toString</a></span>()</code>
<div class="block">Returns the name of 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.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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="BY_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BY_NAME</h4>
<pre>public static final java.util.Comparator<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a>> BY_NAME</pre>
<div class="block">Compares parameters alphabetically by parameter name.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Parameter-java.lang.String-java.lang.Class-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Parameter</h4>
<pre>public Parameter(java.lang.String name,
java.lang.Class<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>> clazz,
boolean allowClassnameValue)</pre>
<div class="block">Constructs a parameter with a given name. This name should be unique
within a given Task.
<p>If the <code>allowClassnameValue</code> flag is set,
then in addition to the options provided by
<a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-"><code>stringToObject</code></a>, any supplied string value
equal to the classname of an available class matching
this parameter's value type which has a no-arg constructor
will cause a newly constructed instance of that class to be
used as a value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the identifying name of this parameter</dd>
<dd><code>clazz</code> - the class of this parameter's typed values</dd>
<dd><code>allowClassnameValue</code> - whether suitable classnames may be
supplied as string values</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 abstract <a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a> stringToObject(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
java.lang.String stringVal)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<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="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>stringVal</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/Parameter.html" title="type parameter in Parameter">T</a> objectVal)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment</dd>
<dd><code>objectVal</code> - typed parameter value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string value for presentation</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="setValueFromString-uk.ac.starlink.task.Environment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValueFromString</h4>
<pre>public void setValueFromString(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
java.lang.String stringval)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<div class="block">Sets the value of this parameter from a String. This method is
called by the Environment to configure the value of this parameter.
<p>A null or empty string is intercepted by this method and translated
to a null object value or triggers a ParameterValueException
according to the value of isNullPermitted().</div>
<dl>
<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>stringval</code> - string representation of 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="setValueFromObject-uk.ac.starlink.task.Environment-java.lang.Object-">
<!-- -->
</a><a name="setValueFromObject-uk.ac.starlink.task.Environment-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValueFromObject</h4>
<pre>public void setValueFromObject(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env,
<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a> objectValue)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<div class="block">Sets the value of this parameter directly from a typed object.
In this case the reported string value is obtained by calling
<a href="../../../../uk/ac/starlink/task/Parameter.html#objectToString-uk.ac.starlink.task.Environment-T-"><code>objectToString</code></a>.</div>
<dl>
<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>objectValue</code> - 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="stringValue-uk.ac.starlink.task.Environment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringValue</h4>
<pre>public final java.lang.String stringValue(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<div class="block">Gets the value of this parameter as a String.
The value is lazily acquired by the supplied environment object.
<p>The returned value may be <tt>null</tt>
only if the <a href="../../../../uk/ac/starlink/task/Parameter.html#isNullPermitted--"><code>isNullPermitted()</code></a> method returns true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment from which value is obtained</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of this parameter as a string, or <tt>null</tt></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></code> - if during the course of trying to obtain
a value the Environment determines that the task should
not continue.</dd>
<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="objectValue-uk.ac.starlink.task.Environment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>objectValue</h4>
<pre>public final <a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a> objectValue(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)
throws <a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></pre>
<div class="block">Gets the value of this parameter as a typed object.
The value is actually acquired by the supplied environment object.
<p>The returned value will generally be null if the string value
that generated it is null or empty. That is only possible
if the <a href="../../../../uk/ac/starlink/task/Parameter.html#isNullPermitted--"><code>isNullPermitted()</code></a> method returns true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment from which value is obtained</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of this parameter as a string, or <tt>null</tt></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></code> - if during the course of trying to obtain
a value the Environment determines that the task should
not continue.</dd>
<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="clearValue-uk.ac.starlink.task.Environment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearValue</h4>
<pre>public void clearValue(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)</pre>
<div class="block">Clears the value of this parameter. Subsequent retrievals of the
parameter value will trigger a request to the environment for a new
value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment within which value will be cleared</dd>
</dl>
</li>
</ul>
<a name="setValue-java.lang.String-java.lang.Object-">
<!-- -->
</a><a name="setValue-java.lang.String-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>protected void setValue(java.lang.String stringValue,
<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a> objectValue)</pre>
<div class="block">Sets the value of this parameter without any additional validation.
This is invoked by setValueFromString and setValueFromObject,
and should not normally be invoked directly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stringValue</code> - string representation of value</dd>
<dd><code>objectValue</code> - typed value</dd>
</dl>
</li>
</ul>
<a name="getValueClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueClass</h4>
<pre>public java.lang.Class<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>> getValueClass()</pre>
<div class="block">Returns the class of the typed values this parameter takes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the class of this parameter's typed values</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block">Returns the name of this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name the identifying name of this parameter</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public void setName(java.lang.String name)</pre>
<div class="block">Sets the name of this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - identifying name of this parameter</dd>
</dl>
</li>
</ul>
<a name="getPrompt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrompt</h4>
<pre>public java.lang.String getPrompt()</pre>
<div class="block">Gets the prompt string for this parameter, as displayed to the
user when the value of the parameter is requested.
Should be short (<40 characters?).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>prompt string</dd>
</dl>
</li>
</ul>
<a name="setPrompt-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrompt</h4>
<pre>public void setPrompt(java.lang.String prompt)</pre>
<div class="block">Sets the prompt string for this parameter, as displayed to the
user when the value of the parameter is requested.
Should be short (<40 characters?).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prompt</code> - the prompt string</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>public java.lang.String getDescription()</pre>
<div class="block">Returns the textual description for this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>description, if known</dd>
</dl>
</li>
</ul>
<a name="setDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>public void setDescription(java.lang.String description)</pre>
<div class="block">Sets the textual description for this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - description</dd>
</dl>
</li>
</ul>
<a name="setDescription-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>public void setDescription(java.lang.String[] descLines)</pre>
<div class="block">Convenience method to set the description for this parameter by
the result of joining an array of lines together.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>descLines</code> - lines of textual description</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String-"><code>setDescription(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">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="paramLabel">Parameters:</span></dt>
<dd><code>usage</code> - usage string</dd>
</dl>
</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 the usage string for this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>usage string</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../uk/ac/starlink/task/Parameter.html#setUsage-java.lang.String-"><code>setUsage(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setNullPermitted-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNullPermitted</h4>
<pre>public void setNullPermitted(boolean permitted)</pre>
<div class="block">Set whether it is legal for this parameter's value to be blank.
By default it is not.
Note that null and blank string values are treated the same as each
other, and are translated to null object values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>permitted</code> - whether null values are to be permitted for this
parameter</dd>
</dl>
</li>
</ul>
<a name="isNullPermitted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNullPermitted</h4>
<pre>public boolean isNullPermitted()</pre>
<div class="block">Determine whether it is legal for this parameter's value to be blank.
By default it is not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if null values are permitted for this parameter</dd>
</dl>
</li>
</ul>
<a name="getPreferExplicit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreferExplicit</h4>
<pre>public boolean getPreferExplicit()</pre>
<div class="block">Determine whether an explict value is generally preferred to the
default value for this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a default value should generally be avoided</dd>
</dl>
</li>
</ul>
<a name="setPreferExplicit-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreferExplicit</h4>
<pre>public void setPreferExplicit(boolean prefer)</pre>
<div class="block">Set whether an explicit value is generally to be solicited from
the user rather than taking the default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefer</code> - true if you would like to encourage an explicit
value to be set for this parameter</dd>
</dl>
</li>
</ul>
<a name="getStringDefault--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringDefault</h4>
<pre>public java.lang.String getStringDefault()</pre>
<div class="block">Gets the default string value for this parameter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default string value</dd>
</dl>
</li>
</ul>
<a name="setStringDefault-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStringDefault</h4>
<pre>public void setStringDefault(java.lang.String stringDflt)</pre>
<div class="block">Sets the default string value for this parameter.
Concrete subclasses may additionally supply type-specific
default value setter methods, but those ought to operate by invoking
this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stringDflt</code> - the default string value</dd>
</dl>
</li>
</ul>
<a name="getPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre>public int getPosition()</pre>
<div class="block">Gets the position of this parameter in a parameter list;
the first parameter is 1. If the position is 0, the value can only
be set by name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>parameter position</dd>
</dl>
</li>
</ul>
<a name="setPosition-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPosition</h4>
<pre>public void setPosition(int pos)</pre>
<div class="block">Sets the position of this parameter in a parameter list;
the first parameter is 1. If the position is 0, the value can only
be set by name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pos</code> - parameter position</dd>
</dl>
</li>
</ul>
<a name="toArray-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public <a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>[] toArray(java.util.Collection<<a href="../../../../uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>> collection)</pre>
<div class="block">Utility function to convert a list to an array, where the elements
are of the value class of this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collection</code> - typed collection</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>typed array with same contents</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns the name of this parameter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string representation</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/OutputStreamParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/task/ParameterValueException.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/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><a href="#field.summary">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><a href="#field.detail">Field</a> | </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>
|