| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>AsyncResult</title> |
| <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="AsyncResult"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="../../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="../../jakarta/ejb/Asynchronous.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/ejb/BeforeCompletion.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/ejb/AsyncResult.html" target="_top">Frames</a></li> |
| <li><a href="AsyncResult.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">jakarta.ejb</div> |
| <h2 title="Class AsyncResult" class="title">Class AsyncResult<V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.ejb.AsyncResult<V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.util.concurrent.Future<V></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">AsyncResult<V></span> |
| extends java.lang.Object |
| implements java.util.concurrent.Future<V></pre> |
| <div class="block">Wraps the result of an asynchronous method call as a <code>Future</code> |
| object, preserving compatability with the business interface signature. |
| <p> |
| The value specified in the constructor will be retrieved by the container |
| and made available to the client. |
| <p> |
| Note that this object is not passed to the client. It is |
| merely a convenience for providing the result value to the container. |
| Therefore, none of its instance methods should be called by the |
| application.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EJB 3.1</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="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="../../jakarta/ejb/AsyncResult.html#AsyncResult-V-">AsyncResult</a></span>(<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a> result)</code> |
| <div class="block">Creates a <code>AsyncResult</code> instance to wrap the result of an |
| asynchronous method call</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/AsyncResult.html#cancel-boolean-">cancel</a></span>(boolean mayInterruptIfRunning)</code> |
| <div class="block">This method should not be called.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/AsyncResult.html#get--">get</a></span>()</code> |
| <div class="block">This method should not be called.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/AsyncResult.html#get-long-java.util.concurrent.TimeUnit-">get</a></span>(long timeout, |
| java.util.concurrent.TimeUnit unit)</code> |
| <div class="block">This method should not be called.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/AsyncResult.html#isCancelled--">isCancelled</a></span>()</code> |
| <div class="block">This method should not be called.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/AsyncResult.html#isDone--">isDone</a></span>()</code> |
| <div class="block">This method should not be called.</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="AsyncResult-java.lang.Object-"> |
| <!-- --> |
| </a><a name="AsyncResult-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AsyncResult</h4> |
| <pre>public AsyncResult(<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a> result)</pre> |
| <div class="block">Creates a <code>AsyncResult</code> instance to wrap the result of an |
| asynchronous method call</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>result</code> - the result of an asynchronous method call to be made |
| available to the client</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="cancel-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>public boolean cancel(boolean mayInterruptIfRunning)</pre> |
| <div class="block">This method should not be called. See Class-level comments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>cancel</code> in interface <code>java.util.concurrent.Future<<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCancelled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCancelled</h4> |
| <pre>public boolean isCancelled()</pre> |
| <div class="block">This method should not be called. See Class-level comments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isCancelled</code> in interface <code>java.util.concurrent.Future<<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a>></code></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">This method should not be called. See Class-level comments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isDone</code> in interface <code>java.util.concurrent.Future<<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a> get() |
| throws java.lang.InterruptedException, |
| java.util.concurrent.ExecutionException</pre> |
| <div class="block">This method should not be called. See Class-level comments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>get</code> in interface <code>java.util.concurrent.Future<<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.InterruptedException</code></dd> |
| <dd><code>java.util.concurrent.ExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a> get(long timeout, |
| java.util.concurrent.TimeUnit unit) |
| throws java.lang.InterruptedException, |
| java.util.concurrent.ExecutionException, |
| java.util.concurrent.TimeoutException</pre> |
| <div class="block">This method should not be called. See Class-level comments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>get</code> in interface <code>java.util.concurrent.Future<<a href="../../jakarta/ejb/AsyncResult.html" title="type parameter in AsyncResult">V</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.InterruptedException</code></dd> |
| <dd><code>java.util.concurrent.ExecutionException</code></dd> |
| <dd><code>java.util.concurrent.TimeoutException</code></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="../../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="../../jakarta/ejb/Asynchronous.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/ejb/BeforeCompletion.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/ejb/AsyncResult.html" target="_top">Frames</a></li> |
| <li><a href="AsyncResult.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> |
