/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html is in libbackport-util-concurrent-java-doc 3.1-3build1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri May 18 11:21:07 UTC 2012 -->
<title>FutureTask</title>
<meta name="date" content="2012-05-18">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FutureTask";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/LinkedBlockingDeque.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html" target="_top">Frames</a></li>
<li><a href="FutureTask.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.emory.mathcs.backport.java.util.concurrent</div>
<h2 title="Class FutureTask" class="title">Class FutureTask</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.emory.mathcs.backport.java.util.concurrent.FutureTask</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RunnableFuture.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RunnableFuture</a>, java.lang.Runnable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FutureTask</span>
extends java.lang.Object
implements <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RunnableFuture.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RunnableFuture</a></pre>
<div class="block">A cancellable asynchronous computation. This class provides a base
implementation of <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>Future</code></a>, with methods to start and cancel
a computation, query to see if the computation is complete, and
retrieve the result of the computation. The result can only be
retrieved when the computation has completed; the <tt>get</tt>
method will block if the computation has not yet completed. Once
the computation has completed, the computation cannot be restarted
or cancelled.
<p>A <tt>FutureTask</tt> can be used to wrap a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Callable.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>Callable</code></a> or
<code>Runnable</code> object. Because <tt>FutureTask</tt>
implements <tt>Runnable</tt>, a <tt>FutureTask</tt> can be
submitted to an <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>Executor</code></a> for execution.
<p>In addition to serving as a standalone class, this class provides
<tt>protected</tt> functionality that may be useful when creating
customized task classes.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.5</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Doug Lea</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#FutureTask(edu.emory.mathcs.backport.java.util.concurrent.Callable)">FutureTask</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Callable.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Callable</a> callable)</code>
<div class="block">Creates a <tt>FutureTask</tt> that will, upon running, execute the
given <tt>Callable</tt>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#FutureTask(java.lang.Runnable, java.lang.Object)">FutureTask</a></strong>(java.lang.Runnable runnable,
java.lang.Object result)</code>
<div class="block">Creates a <tt>FutureTask</tt> that will, upon running, execute the
given <tt>Runnable</tt>, and arrange that <tt>get</tt> will return the
given result on successful completion.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#cancel(boolean)">cancel</a></strong>(boolean mayInterruptIfRunning)</code>
<div class="block">Attempts to cancel execution of this task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#done()">done</a></strong>()</code>
<div class="block">Protected method invoked when this task transitions to state
<tt>isDone</tt> (whether normally or via cancellation).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#get()">get</a></strong>()</code>
<div class="block">Waits if necessary for the computation to complete, and then
retrieves its result.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#get(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">get</a></strong>(long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)</code>
<div class="block">Waits if necessary for at most the given time for the computation
to complete, and then retrieves its result, if available.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#isCancelled()">isCancelled</a></strong>()</code>
<div class="block">Returns <tt>true</tt> if this task was cancelled before it completed
normally.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#isDone()">isDone</a></strong>()</code>
<div class="block">Returns <tt>true</tt> if this task completed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#run()">run</a></strong>()</code>
<div class="block">Sets this Future to the result of its computation
unless it has been cancelled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#runAndReset()">runAndReset</a></strong>()</code>
<div class="block">Executes the computation without setting its result, and then
resets this Future to initial state, failing to do so if the
computation encounters an exception or is cancelled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#set(java.lang.Object)">set</a></strong>(java.lang.Object v)</code>
<div class="block">Sets the result of this Future to the given value unless
this future has already been set or has been cancelled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html#setException(java.lang.Throwable)">setException</a></strong>(java.lang.Throwable t)</code>
<div class="block">Causes this future to report an <tt>ExecutionException</tt>
with the given throwable as its cause, unless this Future has
already been set or has been cancelled.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="FutureTask(edu.emory.mathcs.backport.java.util.concurrent.Callable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FutureTask</h4>
<pre>public FutureTask(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Callable.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Callable</a> callable)</pre>
<div class="block">Creates a <tt>FutureTask</tt> that will, upon running, execute the
given <tt>Callable</tt>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>callable</code> - the callable task</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if callable is null</dd></dl>
</li>
</ul>
<a name="FutureTask(java.lang.Runnable, java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FutureTask</h4>
<pre>public FutureTask(java.lang.Runnable runnable,
java.lang.Object result)</pre>
<div class="block">Creates a <tt>FutureTask</tt> that will, upon running, execute the
given <tt>Runnable</tt>, and arrange that <tt>get</tt> will return the
given result on successful completion.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - the runnable task</dd><dd><code>result</code> - the result to return on successful completion. If
you don't need a particular result, consider using
constructions of the form:
<tt>Future<?> f = new FutureTask<Object>(runnable, null)</tt></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if runnable is null</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isCancelled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCancelled</h4>
<pre>public boolean isCancelled()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#isCancelled()">Future</a></code></strong></div>
<div class="block">Returns <tt>true</tt> if this task was cancelled before it completed
normally.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#isCancelled()">isCancelled</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this task was cancelled before it completed</dd></dl>
</li>
</ul>
<a name="isDone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDone</h4>
<pre>public boolean isDone()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#isDone()">Future</a></code></strong></div>
<div class="block">Returns <tt>true</tt> if this task completed.
Completion may be due to normal termination, an exception, or
cancellation -- in all of these cases, this method will return
<tt>true</tt>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#isDone()">isDone</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this task completed</dd></dl>
</li>
</ul>
<a name="cancel(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>public boolean cancel(boolean mayInterruptIfRunning)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#cancel(boolean)">Future</a></code></strong></div>
<div class="block">Attempts to cancel execution of this task. This attempt will
fail if the task has already completed, has already been cancelled,
or could not be cancelled for some other reason. If successful,
and this task has not started when <tt>cancel</tt> is called,
this task should never run. If the task has already started,
then the <tt>mayInterruptIfRunning</tt> parameter determines
whether the thread executing this task should be interrupted in
an attempt to stop the task.
<p>After this method returns, subsequent calls to <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#isDone()"><code>Future.isDone()</code></a> will
always return <tt>true</tt>. Subsequent calls to <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#isCancelled()"><code>Future.isCancelled()</code></a>
will always return <tt>true</tt> if this method returned <tt>true</tt>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#cancel(boolean)">cancel</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>mayInterruptIfRunning</code> - <tt>true</tt> if the thread executing this
task should be interrupted; otherwise, in-progress tasks are allowed
to complete</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>false</tt> if the task could not be cancelled,
typically because it has already completed normally;
<tt>true</tt> otherwise</dd></dl>
</li>
</ul>
<a name="get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get()
throws java.lang.InterruptedException,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ExecutionException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#get()">Future</a></code></strong></div>
<div class="block">Waits if necessary for the computation to complete, and then
retrieves its result.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#get()">get</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the computed result</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CancellationException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">CancellationException</a></code> - if the computation was cancelled</dd>
<dd><code>java.lang.InterruptedException</code> - if the current thread was interrupted
while waiting</dd>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ExecutionException</a></code> - if the computation threw an
exception</dd></dl>
</li>
</ul>
<a name="get(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.Object get(long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)
throws java.lang.InterruptedException,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ExecutionException</a>,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeoutException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeoutException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#get(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">Future</a></code></strong></div>
<div class="block">Waits if necessary for at most the given time for the computation
to complete, and then retrieves its result, if available.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html#get(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">get</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the maximum time to wait</dd><dd><code>unit</code> - the time unit of the timeout argument</dd>
<dt><span class="strong">Returns:</span></dt><dd>the computed result</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CancellationException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">CancellationException</a></code> - if the computation was cancelled</dd>
<dd><code>java.lang.InterruptedException</code> - if the current thread was interrupted
while waiting</dd>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ExecutionException</a></code> - if the computation threw an
exception</dd>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeoutException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeoutException</a></code> - if the wait timed out</dd></dl>
</li>
</ul>
<a name="done()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>done</h4>
<pre>protected void done()</pre>
<div class="block">Protected method invoked when this task transitions to state
<tt>isDone</tt> (whether normally or via cancellation). The
default implementation does nothing. Subclasses may override
this method to invoke completion callbacks or perform
bookkeeping. Note that you can query status inside the
implementation of this method to determine whether this task
has been cancelled.</div>
</li>
</ul>
<a name="set(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>protected void set(java.lang.Object v)</pre>
<div class="block">Sets the result of this Future to the given value unless
this future has already been set or has been cancelled.
This method is invoked internally by the <tt>run</tt> method
upon successful completion of the computation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the value</dd></dl>
</li>
</ul>
<a name="setException(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setException</h4>
<pre>protected void setException(java.lang.Throwable t)</pre>
<div class="block">Causes this future to report an <tt>ExecutionException</tt>
with the given throwable as its cause, unless this Future has
already been set or has been cancelled.
This method is invoked internally by the <tt>run</tt> method
upon failure of the computation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - the cause of failure</dd></dl>
</li>
</ul>
<a name="run()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public void run()</pre>
<div class="block">Sets this Future to the result of its computation
unless it has been cancelled.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RunnableFuture.html#run()">run</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RunnableFuture.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RunnableFuture</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>run</code> in interface <code>java.lang.Runnable</code></dd>
</dl>
</li>
</ul>
<a name="runAndReset()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>runAndReset</h4>
<pre>protected boolean runAndReset()</pre>
<div class="block">Executes the computation without setting its result, and then
resets this Future to initial state, failing to do so if the
computation encounters an exception or is cancelled. This is
designed for use with tasks that intrinsically execute more
than once.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if successfully run and reset</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/LinkedBlockingDeque.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html" target="_top">Frames</a></li>
<li><a href="FutureTask.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|