/usr/share/doc/starlink-task-java-doc/api/uk/ac/starlink/task/IntegerParameter.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>IntegerParameter (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="IntegerParameter (Starjava Task API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../uk/ac/starlink/task/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../uk/ac/starlink/task/InputStreamParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/task/InvokeUtils.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/IntegerParameter.html" target="_top">Frames</a></li>
<li><a href="IntegerParameter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.uk.ac.starlink.task.Parameter">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">uk.ac.starlink.task</div>
<h2 title="Class IntegerParameter" class="title">Class IntegerParameter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">uk.ac.starlink.task.Parameter</a><java.lang.Integer></li>
<li>
<ul class="inheritance">
<li>uk.ac.starlink.task.IntegerParameter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">IntegerParameter</span>
extends <a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><java.lang.Integer></pre>
<div class="block">Parameter representing an integer value.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.uk.ac.starlink.task.Parameter">
<!-- -->
</a>
<h3>Fields inherited from class uk.ac.starlink.task.<a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></h3>
<code><a href="../../../../uk/ac/starlink/task/Parameter.html#BY_NAME">BY_NAME</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#IntegerParameter-java.lang.String-">IntegerParameter</a></span>(java.lang.String name)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#intValue-uk.ac.starlink.task.Environment-">intValue</a></span>(<a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a> env)</code>
<div class="block">Returns the value of this parameter as an int primitive.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#setEven--">setEven</a></span>()</code>
<div class="block">Mandates that any value of this parameter must be even.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#setIntDefault-int-">setIntDefault</a></span>(int dflt)</code>
<div class="block">Sets the default value as an integer.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#setMaximum-int-">setMaximum</a></span>(int max)</code>
<div class="block">Mandates a maximum value for this parameter.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#setMinimum-int-">setMinimum</a></span>(int min)</code>
<div class="block">Mandates a minimum value for this parameter.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html#setOdd--">setOdd</a></span>()</code>
<div class="block">Mandates that any value of this parameter must be odd.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/task/IntegerParameter.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>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.uk.ac.starlink.task.Parameter">
<!-- -->
</a>
<h3>Methods inherited from class uk.ac.starlink.task.<a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a></h3>
<code><a href="../../../../uk/ac/starlink/task/Parameter.html#clearValue-uk.ac.starlink.task.Environment-">clearValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getDescription--">getDescription</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getName--">getName</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getPosition--">getPosition</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getPreferExplicit--">getPreferExplicit</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getPrompt--">getPrompt</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getStringDefault--">getStringDefault</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getUsage--">getUsage</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#getValueClass--">getValueClass</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#isNullPermitted--">isNullPermitted</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#objectToString-uk.ac.starlink.task.Environment-T-">objectToString</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#objectValue-uk.ac.starlink.task.Environment-">objectValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setDescription-java.lang.String:A-">setDescription</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setName-java.lang.String-">setName</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setNullPermitted-boolean-">setNullPermitted</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setPosition-int-">setPosition</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setPreferExplicit-boolean-">setPreferExplicit</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setPrompt-java.lang.String-">setPrompt</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setStringDefault-java.lang.String-">setStringDefault</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setUsage-java.lang.String-">setUsage</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setValue-java.lang.String-T-">setValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setValueFromObject-uk.ac.starlink.task.Environment-T-">setValueFromObject</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#setValueFromString-uk.ac.starlink.task.Environment-java.lang.String-">setValueFromString</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#stringValue-uk.ac.starlink.task.Environment-">stringValue</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#toArray-java.util.Collection-">toArray</a>, <a href="../../../../uk/ac/starlink/task/Parameter.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IntegerParameter-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IntegerParameter</h4>
<pre>public IntegerParameter(java.lang.String name)</pre>
</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 java.lang.Integer 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/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">Parameter</a></code></span></div>
<div class="block">Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.
This method also performs validation, so if the string value
is unacceptable in any way, a ParameterValueException should
be thrown.
<p>It is an error to supply a null or empty string value.
<p>If this method fails (throws a ParameterValueException)
and if <code>allowClassnameValue</code> is set, then a subsequent
attempt will be made to interpret the <code>stringVal</code>
as the classname of a suitable class with a no-arg constructor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../uk/ac/starlink/task/Parameter.html#stringToObject-uk.ac.starlink.task.Environment-java.lang.String-">stringToObject</a></code> in class <code><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a><java.lang.Integer></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the result</dd>
<dd><code>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/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></code></dd>
</dl>
</li>
</ul>
<a name="intValue-uk.ac.starlink.task.Environment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intValue</h4>
<pre>public int intValue(<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">Returns the value of this parameter as an int primitive.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>int value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if parameter value is null
(only possible if isNullPermitted true)</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="setIntDefault-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIntDefault</h4>
<pre>public void setIntDefault(int dflt)</pre>
<div class="block">Sets the default value as an integer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dflt</code> - new default value</dd>
</dl>
</li>
</ul>
<a name="setEven--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEven</h4>
<pre>public void setEven()</pre>
<div class="block">Mandates that any value of this parameter must be even.</div>
</li>
</ul>
<a name="setOdd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOdd</h4>
<pre>public void setOdd()</pre>
<div class="block">Mandates that any value of this parameter must be odd.</div>
</li>
</ul>
<a name="setMinimum-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinimum</h4>
<pre>public void setMinimum(int min)</pre>
<div class="block">Mandates a minimum value for this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>min</code> - the smallest value this parameter may take</dd>
</dl>
</li>
</ul>
<a name="setMaximum-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setMaximum</h4>
<pre>public void setMaximum(int max)</pre>
<div class="block">Mandates a maximum value for this parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>max</code> - the largest value this parameter may take.</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/InputStreamParameter.html" title="class in uk.ac.starlink.task"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/task/InvokeUtils.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/IntegerParameter.html" target="_top">Frames</a></li>
<li><a href="IntegerParameter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.uk.ac.starlink.task.Parameter">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.<i></small></p>
</body>
</html>
|