starlink-task-java-doc 0.2+2016.05.03-1 / usr / share / doc / starlink-task-java-doc / api / index-all.html

This file is indexed.

/usr/share/doc/starlink-task-java-doc/api/index-all.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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>Index (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="Index (Starjava Task API)";
        }
    }
    catch(err) {
    }
//-->
</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</li>
<li><a href="uk/ac/starlink/task/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a name="I:A">
<!--   -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><a href="uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">AbortException</span></a> - Exception in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Exception generated when the user signals an intention to abort a task.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/AbortException.html#AbortException--">AbortException()</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/AbortException.html#AbortException-java.lang.String-">AbortException(String)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/AbortException.html#AbortException-java.lang.String-java.lang.Throwable-">AbortException(String, Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/AbortException.html#AbortException-java.lang.Throwable-">AbortException(Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Environment.html#acquireValue-uk.ac.starlink.task.Parameter-">acquireValue(Parameter)</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a></dt>
<dd>
<div class="block">Obtains a legal value for a given parameter from the environment and 
 sets the parameter's value accordingly.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#acquireValue-uk.ac.starlink.task.Parameter-">acquireValue(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#acquireValue-uk.ac.starlink.task.Parameter-">acquireValue(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>
<div class="block">Sets the value of a parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#addOption-T-java.lang.String-">addOption(T, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Adds an option value to this parameter with a given name.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#addOption-T-">addOption(T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Adds an option value to this parameter.</div>
</dd>
</dl>
<a name="I:B">
<!--   -->
</a>
<h2 class="title">B</h2>
<dl>
<dt><a href="uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">BooleanParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter value representing a boolean value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/BooleanParameter.html#BooleanParameter-java.lang.String-">BooleanParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task">BooleanParameter</a></dt>
<dd>
<div class="block">Constructs a new boolean parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/BooleanParameter.html#booleanValue-uk.ac.starlink.task.Environment-">booleanValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task">BooleanParameter</a></dt>
<dd>
<div class="block">Returns the value of this parameter as a boolean.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#BY_NAME">BY_NAME</a></span> - Static variable in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Compares parameters alphabetically by parameter name.</div>
</dd>
</dl>
<a name="I:C">
<!--   -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#checkParameters-uk.ac.starlink.task.Parameter:A-">checkParameters(Parameter[])</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Checks that this environment's values are compatible with the given
 list of parameters.</div>
</dd>
<dt><a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">ChoiceParameter</span></a>&lt;<a href="uk/ac/starlink/task/ChoiceParameter.html" title="type parameter in ChoiceParameter">T</a>&gt; - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter whose legal value must be one of a disjunction of given values.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#ChoiceParameter-java.lang.String-java.lang.Class-T:A-">ChoiceParameter(String, Class&lt;T&gt;, T[])</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#ChoiceParameter-java.lang.String-java.lang.Class-">ChoiceParameter(String, Class&lt;T&gt;)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Constructs a choice parameter with no initially set options.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#ChoiceParameter-java.lang.String-T:A-">ChoiceParameter(String, T[])</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Constructs a choice parameter with an initial option set.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#clear-uk.ac.starlink.task.Parameter-">clear(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#clearOptions--">clearOptions()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Clears the list of known options.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Environment.html#clearValue-uk.ac.starlink.task.Parameter-">clearValue(Parameter)</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a></dt>
<dd>
<div class="block">Clears a value for a given parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#clearValue-uk.ac.starlink.task.Parameter-">clearValue(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#clearValue-uk.ac.starlink.task.Environment-">clearValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Clears the value of this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#clearValue-uk.ac.starlink.task.Parameter-">clearValue(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#configureLogging-int-boolean-">configureLogging(int, boolean)</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>
<div class="block">Sets up the logging system.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Task.html#createExecutable-uk.ac.starlink.task.Environment-">createExecutable(Environment)</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task">Task</a></dt>
<dd>
<div class="block">Creates an executable object which will do the work of this task
 in the given Environment.</div>
</dd>
</dl>
<a name="I:D">
<!--   -->
</a>
<h2 class="title">D</h2>
<dl>
<dt><a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">DoubleParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter representing a double precision number.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#DoubleParameter-java.lang.String-">DoubleParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#doubleValue-uk.ac.starlink.task.Environment-">doubleValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>
<div class="block">Returns the value of this parameter as a <tt>double</tt>.</div>
</dd>
</dl>
<a name="I:E">
<!--   -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><a href="uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task"><span class="typeNameLink">Environment</span></a> - Interface in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Defines an execution environment within which tasks can operate.</div>
</dd>
<dt><a href="uk/ac/starlink/task/Executable.html" title="interface in uk.ac.starlink.task"><span class="typeNameLink">Executable</span></a> - Interface in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Defines an object which does the work of a task without any further
 user or environment interaction.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Executable.html#execute--">execute()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Executable.html" title="interface in uk.ac.starlink.task">Executable</a></dt>
<dd>
<div class="block">Performs the work defined by this object.</div>
</dd>
<dt><a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">ExecutionException</span></a> - Exception in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Exception generated when a task does not complete correctly for some
 known reason.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#ExecutionException--">ExecutionException()</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#ExecutionException-java.lang.String-">ExecutionException(String)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#ExecutionException-java.lang.String-int-">ExecutionException(String, int)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#ExecutionException-java.lang.String-java.lang.Throwable-">ExecutionException(String, Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#ExecutionException-java.lang.Throwable-">ExecutionException(Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:F">
<!--   -->
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineFormatter.html#format-java.util.logging.LogRecord-">format(LogRecord)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineFormatter.html" title="class in uk.ac.starlink.task">LineFormatter</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:G">
<!--   -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getAssignments--">getAssignments()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Returns an array of strings, one for each parameter assignment
 which was actually used (via <a href="uk/ac/starlink/task/LineEnvironment.html#acquireValue-uk.ac.starlink.task.Parameter-"><code>LineEnvironment.acquireValue(uk.ac.starlink.task.Parameter)</code></a>)
 for this environment.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getDescription--">getDescription()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Returns the textual description for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#getErrorCode--">getErrorCode()</a></span> - Method in exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Environment.html#getErrorStream--">getErrorStream()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a></dt>
<dd>
<div class="block">Returns an output stream into which error or logging output from
 a task can be written.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getErrorStream--">getErrorStream()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#getErrorStream--">getErrorStream()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>
<div class="block">Returns <tt>System.err</tt>.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getInteractive--">getInteractive()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Determines whether we are running interactively.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#getJavaVersion--">getJavaVersion()</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>
<div class="block">Returns the JVM version, without throwing any exceptions.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#getJavaVM--">getJavaVM()</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>
<div class="block">Returns the JVM name and version string, without throwing any exceptions.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#getName-T-">getName(T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineWord.html#getName--">getName()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task">LineWord</a></dt>
<dd>
<div class="block">Returns the parameter name represented by this word.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getName--">getName()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Returns the name of this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Environment.html#getNames--">getNames()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a></dt>
<dd>
<div class="block">Returns an array of parameter names which have been specified.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getNames--">getNames()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#getNames--">getNames()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ObjectFactoryParameter.html#getObjectFactory--">getObjectFactory()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task">ObjectFactoryParameter</a></dt>
<dd>
<div class="block">Returns the object factory used by this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#getOption-java.lang.String-">getOption(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Returns the option value associated with a given string by this
 parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#getOptionNames--">getOptionNames()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Returns an array of the string values of options accepted by this
 parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#getOptions--">getOptions()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Returns an array of the option objects which may form the
 values of this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#getOptionValueList--">getOptionValueList()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Returns a collection of the option objects which may form the
 values of this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Environment.html#getOutputStream--">getOutputStream()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a></dt>
<dd>
<div class="block">Returns an output stream into which text output from a task can
 be written.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getOutputStream--">getOutputStream()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#getOutputStream--">getOutputStream()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>
<div class="block">Returns <tt>System.out</tt>.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ParameterValueException.html#getParameter--">getParameter()</a></span> - Method in exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></dt>
<dd>
<div class="block">Returns the parameter with which this exception is associated.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Task.html#getParameters--">getParameters()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task">Task</a></dt>
<dd>
<div class="block">Returns the list of parameters which may be used by this task.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getParamHelp-uk.ac.starlink.task.Parameter-">getParamHelp(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Returns the help string for a given parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getPosition--">getPosition()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Gets the position of this parameter in a parameter list;
 the first parameter is 1.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getPreferExplicit--">getPreferExplicit()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Determine whether an explict value is generally preferred to the
 default value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getPrompt--">getPrompt()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Gets the prompt string for this parameter, as displayed to the 
 user when the value of the parameter is requested.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getPromptAll--">getPromptAll()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Determines whether all parameters which haven't received explicit
 values on the command line should be prompted for.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Task.html#getPurpose--">getPurpose()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task">Task</a></dt>
<dd>
<div class="block">Returns a short (one-line) description of the purpose of this task.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getStringDefault--">getStringDefault()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Gets the default string value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalInvoker.html#getTaskUsage-uk.ac.starlink.task.Task-">getTaskUsage(Task)</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalInvoker.html" title="class in uk.ac.starlink.task">TerminalInvoker</a></dt>
<dd>
<div class="block">Returns a usage string for a given task.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineWord.html#getText--">getText()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task">LineWord</a></dt>
<dd>
<div class="block">Returns the full text of the original command-line argument.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#getUnused--">getUnused()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Returns a string containing any words of the input argument list
 which were never queried by the application to find their
 value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#getUsage--">getUsage()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Returns a usage message.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ObjectFactoryParameter.html#getUsage--">getUsage()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task">ObjectFactoryParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getUsage--">getUsage()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Returns the usage string for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/SingleTaskInvoker.html#getUsage--">getUsage()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/SingleTaskInvoker.html" title="class in uk.ac.starlink.task">SingleTaskInvoker</a></dt>
<dd>
<div class="block">Returns a usage string for this invoker.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineWord.html#getValue--">getValue()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task">LineWord</a></dt>
<dd>
<div class="block">Returns the parameter value represented by this word.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#getValueClass--">getValueClass()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Returns the class of the typed values this parameter takes.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/MultiParameter.html#getValueSeparator--">getValueSeparator()</a></span> - Method in interface uk.ac.starlink.task.<a href="uk/ac/starlink/task/MultiParameter.html" title="interface in uk.ac.starlink.task">MultiParameter</a></dt>
<dd>
<div class="block">Returns a character which is to be used as the separator between
 values found in adjacent occurrences of the parameter in the
 execution environment.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/MultiTaskInvoker.html#getVersionMessage--">getVersionMessage()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/MultiTaskInvoker.html" title="class in uk.ac.starlink.task">MultiTaskInvoker</a></dt>
<dd>
<div class="block">Returns the message to be reported if the "-version" flag is
 given.</div>
</dd>
</dl>
<a name="I:I">
<!--   -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#INDIRECTION_CHAR">INDIRECTION_CHAR</a></span> - Static variable in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><a href="uk/ac/starlink/task/InputStreamParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">InputStreamParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter which can provide an input stream based on its value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InputStreamParameter.html#InputStreamParameter-java.lang.String-">InputStreamParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InputStreamParameter.html" title="class in uk.ac.starlink.task">InputStreamParameter</a></dt>
<dd>&nbsp;</dd>
<dt><a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">IntegerParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter representing an integer value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#IntegerParameter-java.lang.String-">IntegerParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#intValue-uk.ac.starlink.task.Environment-">intValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>
<div class="block">Returns the value of this parameter as an int primitive.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/MultiTaskInvoker.html#invoke-java.lang.String:A-">invoke(String[])</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/MultiTaskInvoker.html" title="class in uk.ac.starlink.task">MultiTaskInvoker</a></dt>
<dd>
<div class="block">Invokes one of the tasks known by this invoker given a command line.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/SingleTaskInvoker.html#invoke-java.lang.String:A-">invoke(String[])</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/SingleTaskInvoker.html" title="class in uk.ac.starlink.task">SingleTaskInvoker</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalInvoker.html#invoke-java.lang.String:A-">invoke(String[])</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalInvoker.html" title="class in uk.ac.starlink.task">TerminalInvoker</a></dt>
<dd>
<div class="block">Invokes a method from this TerminalInvoker's class.</div>
</dd>
<dt><a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">InvokeUtils</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Provides some utility functions used by classes which invoke tasks.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#InvokeUtils--">InvokeUtils()</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#isHidden-uk.ac.starlink.task.Parameter-">isHidden(Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Determines whether a parameter is "hidden", that is its value
 should not be revealed to prying eyes.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#isNullPermitted--">isNullPermitted()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Determine whether it is legal for this parameter's value to be blank.</div>
</dd>
</dl>
<a name="I:L">
<!--   -->
</a>
<h2 class="title">L</h2>
<dl>
<dt><a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">LineEnvironment</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Execution environment for use from the command line.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#LineEnvironment--">LineEnvironment()</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Constructs a LineEnvironment without any additional initialisation.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#LineEnvironment-java.lang.String:A-uk.ac.starlink.task.Parameter:A-">LineEnvironment(String[], Parameter[])</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Constructs a new LineEnvironment, initialising it with a set of command
 line arguments.</div>
</dd>
<dt><a href="uk/ac/starlink/task/LineFormatter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">LineFormatter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Compact log record formatter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineFormatter.html#LineFormatter-boolean-">LineFormatter(boolean)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineFormatter.html" title="class in uk.ac.starlink.task">LineFormatter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><a href="uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">LineWord</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Represents a single word on the command line used as by LineEnvironment.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineWord.html#LineWord-java.lang.String-">LineWord(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task">LineWord</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><a href="uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">LongParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter representing a long integer value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LongParameter.html#LongParameter-java.lang.String-">LongParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LongParameter.html#longValue-uk.ac.starlink.task.Environment-">longValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a></dt>
<dd>
<div class="block">Returns the value of this parameter as long primitive.</div>
</dd>
</dl>
<a name="I:M">
<!--   -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>
<div class="block">Invokes the main method of a named class with logging configuration
 specified on the command line.</div>
</dd>
<dt><a href="uk/ac/starlink/task/MultiParameter.html" title="interface in uk.ac.starlink.task"><span class="typeNameLink">MultiParameter</span></a> - Interface in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Marker interface which marks a parameter as one which can have multiple
 appearances on the command line.</div>
</dd>
<dt><a href="uk/ac/starlink/task/MultiTaskInvoker.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">MultiTaskInvoker</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Invokes tasks from a command line when the tasks are available from 
 an <code>ObjectFactory</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/MultiTaskInvoker.html#MultiTaskInvoker-java.lang.String-uk.ac.starlink.util.ObjectFactory-">MultiTaskInvoker(String, ObjectFactory&lt;Task&gt;)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/MultiTaskInvoker.html" title="class in uk.ac.starlink.task">MultiTaskInvoker</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
</dl>
<a name="I:N">
<!--   -->
</a>
<h2 class="title">N</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#NUM_TRIES">NUM_TRIES</a></span> - Static variable in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#NUM_TRIES">NUM_TRIES</a></span> - Static variable in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>
<div class="block">The number of goes you get to put in an invalid parameter.</div>
</dd>
</dl>
<a name="I:O">
<!--   -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><a href="uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">ObjectFactoryParameter</span></a>&lt;<a href="uk/ac/starlink/task/ObjectFactoryParameter.html" title="type parameter in ObjectFactoryParameter">T</a>&gt; - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter whose (user-supplied) string values correspond to nicknames
 from an <code>ObjectFactory</code>.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ObjectFactoryParameter.html#ObjectFactoryParameter-java.lang.String-uk.ac.starlink.util.ObjectFactory-">ObjectFactoryParameter(String, ObjectFactory&lt;T&gt;)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task">ObjectFactoryParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#objectToString-uk.ac.starlink.task.Environment-T-">objectToString(Environment, T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#objectToString-uk.ac.starlink.task.Environment-T-">objectToString(Environment, T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#objectValue-uk.ac.starlink.task.Environment-">objectValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Gets the value of this parameter as a typed object.</div>
</dd>
<dt><a href="uk/ac/starlink/task/OutputStreamParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">OutputStreamParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter for selecting an output stream to write to.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/OutputStreamParameter.html#OutputStreamParameter-java.lang.String-">OutputStreamParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/OutputStreamParameter.html" title="class in uk.ac.starlink.task">OutputStreamParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
</dl>
<a name="I:P">
<!--   -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Parameter</span></a>&lt;<a href="uk/ac/starlink/task/Parameter.html" title="type parameter in Parameter">T</a>&gt; - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">A Parameter describes the function of one of a task's parameters.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#Parameter-java.lang.String-java.lang.Class-boolean-">Parameter(String, Class&lt;T&gt;, boolean)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Constructs a parameter with a given name.</div>
</dd>
<dt><a href="uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">ParameterValueException</span></a> - Exception in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Exception generated when the value of a parameter is invalid.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ParameterValueException.html#ParameterValueException-uk.ac.starlink.task.Parameter-">ParameterValueException(Parameter)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ParameterValueException.html#ParameterValueException-uk.ac.starlink.task.Parameter-java.lang.String-">ParameterValueException(Parameter, String)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ParameterValueException.html#ParameterValueException-uk.ac.starlink.task.Parameter-java.lang.String-java.lang.Throwable-">ParameterValueException(Parameter, String, Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ParameterValueException.html#ParameterValueException-uk.ac.starlink.task.Parameter-java.lang.Throwable-">ParameterValueException(Parameter, Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#paramNameMatches-java.lang.String-uk.ac.starlink.task.Parameter-">paramNameMatches(String, Parameter)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Indicates whether a parameter name supplied from the environment
 is a reference to a given parameter.</div>
</dd>
</dl>
<a name="I:S">
<!--   -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/BooleanParameter.html#setBooleanDefault-boolean-">setBooleanDefault(boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task">BooleanParameter</a></dt>
<dd>
<div class="block">Sets the default as a boolean value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#setDefaultOption-T-">setDefaultOption(T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<div class="block">Sets the default value for this parameter to one of the previously
 added options.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String-">setDescription(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the textual description for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String:A-">setDescription(String[])</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Convenience method to set the description for this parameter by 
 the result of joining an array of lines together.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#setDoubleDefault-double-">setDoubleDefault(double)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>
<div class="block">Sets the default value as a floating point value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ExecutionException.html#setErrorCode-int-">setErrorCode(int)</a></span> - Method in exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#setErrorStream-java.io.PrintStream-">setErrorStream(PrintStream)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Sets the destination stream for standard error.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#setEven--">setEven()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>
<div class="block">Mandates that any value of this parameter must be even.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#setIntDefault-int-">setIntDefault(int)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>
<div class="block">Sets the default value as an integer.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#setInteractive-boolean-">setInteractive(boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Sets whether we are running interactively or not.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#setMaximum-double-boolean-">setMaximum(double, boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>
<div class="block">Sets the maximum acceptable value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#setMaximum-int-">setMaximum(int)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>
<div class="block">Mandates a maximum value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LongParameter.html#setMaximum-long-">setMaximum(long)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a></dt>
<dd>
<div class="block">Mandates a maximum value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#setMinimum-double-boolean-">setMinimum(double, boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>
<div class="block">Sets the minimum acceptable value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#setMinimum-int-">setMinimum(int)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>
<div class="block">Mandates a minimum value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LongParameter.html#setMinimum-long-">setMinimum(long)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a></dt>
<dd>
<div class="block">Mandates a minimum value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setName-java.lang.String-">setName(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the name of this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setNullPermitted-boolean-">setNullPermitted(boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Set whether it is legal for this parameter's value to be blank.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#setOdd--">setOdd()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>
<div class="block">Mandates that any value of this parameter must be odd.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#setOutputStream-java.io.PrintStream-">setOutputStream(PrintStream)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Sets the destination stream for standard out.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setPosition-int-">setPosition(int)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the position of this parameter in a parameter list;
 the first parameter is 1.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setPreferExplicit-boolean-">setPreferExplicit(boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Set whether an explicit value is generally to be solicited from 
 the user rather than taking the default.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setPrompt-java.lang.String-">setPrompt(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the prompt string for this parameter, as displayed to the 
 user when the value of the parameter is requested.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#setPromptAll-boolean-">setPromptAll(boolean)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Sets whether all parameters which haven't received explicit values
 on the command line should be prompted for.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setStringDefault-java.lang.String-">setStringDefault(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the default string value for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#setUsage-java.lang.String-">setUsage(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setUsage-java.lang.String-">setUsage(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets a usage string for this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setValue-java.lang.String-T-">setValue(String, T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the value of this parameter without any additional validation.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setValueFromObject-uk.ac.starlink.task.Environment-T-">setValueFromObject(Environment, T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the value of this parameter directly from a typed object.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#setValueFromString-uk.ac.starlink.task.Environment-java.lang.String-">setValueFromString(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>
<div class="block">As a special case, setting the value of this parameter with a
 null or empty string will result in a NaN value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#setValueFromString-uk.ac.starlink.task.Environment-java.lang.String-">setValueFromString(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Sets the value of this parameter from a String.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/MultiTaskInvoker.html#setVersionMessage-java.lang.String-">setVersionMessage(String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/MultiTaskInvoker.html" title="class in uk.ac.starlink.task">MultiTaskInvoker</a></dt>
<dd>
<div class="block">Sets the message which will be reported if the "-version" flag is
 given.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineEnvironment.html#setWords-uk.ac.starlink.task.LineWord:A-">setWords(LineWord[])</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></dt>
<dd>
<div class="block">Sets the words supplying the parameter values for this environment.</div>
</dd>
<dt><a href="uk/ac/starlink/task/SingleTaskInvoker.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">SingleTaskInvoker</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Invoker which only knows how to invoke a single given task.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/SingleTaskInvoker.html#SingleTaskInvoker-uk.ac.starlink.task.Task-java.lang.String-">SingleTaskInvoker(Task, String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/SingleTaskInvoker.html" title="class in uk.ac.starlink.task">SingleTaskInvoker</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#sortParameters-uk.ac.starlink.task.Parameter:A-">sortParameters(Parameter[])</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>
<div class="block">Sorts a list of Parameter objects.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#stringifyOption-T-">stringifyOption(T)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>
<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>
</dd>
<dt><a href="uk/ac/starlink/task/StringParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">StringParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter for holding string values.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/StringParameter.html#StringParameter-java.lang.String-">StringParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/StringParameter.html" title="class in uk.ac.starlink.task">StringParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/BooleanParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task">BooleanParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ChoiceParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/DoubleParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InputStreamParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InputStreamParameter.html" title="class in uk.ac.starlink.task">InputStreamParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/IntegerParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LongParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/ObjectFactoryParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task">ObjectFactoryParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/OutputStreamParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/OutputStreamParameter.html" title="class in uk.ac.starlink.task">OutputStreamParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/StringParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/StringParameter.html" title="class in uk.ac.starlink.task">StringParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/URLParameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject(Environment, String)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/URLParameter.html" title="class in uk.ac.starlink.task">URLParameter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#stringValue-uk.ac.starlink.task.Environment-">stringValue(Environment)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Gets the value of this parameter as a String.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/InvokeUtils.html#summariseError-java.lang.Throwable-java.io.PrintStream-">summariseError(Throwable, PrintStream)</a></span> - Static method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></dt>
<dd>
<div class="block">Writes a summary of a (possibly nested) exception to a given
 output stream.</div>
</dd>
</dl>
<a name="I:T">
<!--   -->
</a>
<h2 class="title">T</h2>
<dl>
<dt><a href="uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task"><span class="typeNameLink">Task</span></a> - Interface in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Defines a user-level task.</div>
</dd>
<dt><a href="uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">TaskException</span></a> - Exception in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Superclass for exceptions in the task package.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TaskException.html#TaskException--">TaskException()</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TaskException.html#TaskException-java.lang.String-">TaskException(String)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TaskException.html#TaskException-java.lang.String-java.lang.Throwable-">TaskException(String, Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TaskException.html#TaskException-java.lang.Throwable-">TaskException(Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></dt>
<dd>&nbsp;</dd>
<dt><a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">TerminalEnvironment</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Implementation of Environment which accepts an initial command line,
 and communicates with the user using standard input and standard output.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalEnvironment.html#TerminalEnvironment-java.lang.String:A-uk.ac.starlink.task.Parameter:A-">TerminalEnvironment(String[], Parameter[])</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></dt>
<dd>
<div class="block">Constructs a new Environment based on a String array containing
 supplied arguments, and a list of parameters which may be encountered.</div>
</dd>
<dt><a href="uk/ac/starlink/task/TerminalInvoker.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">TerminalInvoker</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Invokes Task objects in a way suitable for use from the <tt>main</tt> 
 method, using a command line interface.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/TerminalInvoker.html#TerminalInvoker-java.lang.String-java.util.Map-">TerminalInvoker(String, Map&lt;String, Task&gt;)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/TerminalInvoker.html" title="class in uk.ac.starlink.task">TerminalInvoker</a></dt>
<dd>
<div class="block">Creates a new invoker based on the given class with a given name.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#toArray-java.util.Collection-">toArray(Collection&lt;T&gt;)</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Utility function to convert a list to an array, where the elements
 are of the value class of this parameter.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/LineWord.html#toString--">toString()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task">LineWord</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/Parameter.html#toString--">toString()</a></span> - Method in class uk.ac.starlink.task.<a href="uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></dt>
<dd>
<div class="block">Returns the name of this parameter.</div>
</dd>
</dl>
<a name="I:U">
<!--   -->
</a>
<h2 class="title">U</h2>
<dl>
<dt><a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a> - package uk.ac.starlink.task</dt>
<dd>
<div class="block">A framework for invoking user-level tasks.</div>
</dd>
<dt><a href="uk/ac/starlink/task/URLParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">URLParameter</span></a> - Class in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">Parameter representing a URL value.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/URLParameter.html#URLParameter-java.lang.String-">URLParameter(String)</a></span> - Constructor for class uk.ac.starlink.task.<a href="uk/ac/starlink/task/URLParameter.html" title="class in uk.ac.starlink.task">URLParameter</a></dt>
<dd>
<div class="block">Constructor.</div>
</dd>
<dt><a href="uk/ac/starlink/task/UsageException.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">UsageException</span></a> - Exception in <a href="uk/ac/starlink/task/package-summary.html">uk.ac.starlink.task</a></dt>
<dd>
<div class="block">An Exception thrown when a task is invoked with the wrong usage.</div>
</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/UsageException.html#UsageException--">UsageException()</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/UsageException.html" title="class in uk.ac.starlink.task">UsageException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/UsageException.html#UsageException-java.lang.String-">UsageException(String)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/UsageException.html" title="class in uk.ac.starlink.task">UsageException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/UsageException.html#UsageException-java.lang.String-java.lang.Throwable-">UsageException(String, Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/UsageException.html" title="class in uk.ac.starlink.task">UsageException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="uk/ac/starlink/task/UsageException.html#UsageException-java.lang.Throwable-">UsageException(Throwable)</a></span> - Constructor for exception uk.ac.starlink.task.<a href="uk/ac/starlink/task/UsageException.html" title="class in uk.ac.starlink.task">UsageException</a></dt>
<dd>&nbsp;</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;</div>
<!-- ======= 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</li>
<li><a href="uk/ac/starlink/task/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright &#169; 2017 Central Laboratory of the Research Councils. All Rights Reserved.<i></small></p>
</body>
</html>

APT Browse - Built by Thomas Orozco.