|
|
<!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_45) on Sat Jul 26 15:44:25 PDT 2014 -->
<title>SimpleFutureAction (Spark 1.0.1 JavaDoc)</title>
<meta name="date" content="2014-07-26">
<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="SimpleFutureAction (Spark 1.0.1 JavaDoc)";
}
//-->
</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="../../../org/apache/spark/ShuffleDependency.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/SimpleFutureAction.html" target="_top">Frames</a></li>
<li><a href="SimpleFutureAction.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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">org.apache.spark</div>
<h2 title="Class SimpleFutureAction" class="title">Class SimpleFutureAction<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.SimpleFutureAction<T></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><T>, scala.concurrent.Awaitable<T>, scala.concurrent.Future<T></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SimpleFutureAction<T></span>
extends Object
implements <a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><T></pre>
<div class="block">:: Experimental ::
A <a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark"><code>FutureAction</code></a> holding the result of an action that triggers a single job. Examples include
count, collect, reduce.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_scala.concurrent.Future">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface scala.concurrent.Future</h3>
<code>scala.concurrent.Future.InternalCallbackExecutor$</code></li>
</ul>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#cancel()">cancel</a></strong>()</code>
<div class="block">Cancels the execution of this action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#isCompleted()">isCompleted</a></strong>()</code>
<div class="block">Returns whether the action has already been completed with a value or an exception.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><U> void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#onComplete(scala.Function1, scala.concurrent.ExecutionContext)">onComplete</a></strong>(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>,U> func,
scala.concurrent.ExecutionContext executor)</code>
<div class="block">When this action is completed, either through an exception, or a value, applies the provided
function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/SimpleFutureAction.html" title="class in org.apache.spark">SimpleFutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">ready</a></strong>(scala.concurrent.duration.Duration atMost,
scala.concurrent.CanAwait permit)</code>
<div class="block">Blocks until this action completes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">result</a></strong>(scala.concurrent.duration.Duration atMost,
scala.concurrent.CanAwait permit)</code>
<div class="block">Awaits and returns the result (of type T) of this action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.Option<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#value()">value</a></strong>()</code>
<div class="block">The value of this Future.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_Object">
<!-- -->
</a>
<h3>Methods inherited from class Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.FutureAction">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.spark.<a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a></h3>
<code><a href="../../../org/apache/spark/FutureAction.html#get()">get</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_scala.concurrent.Future">
<!-- -->
</a>
<h3>Methods inherited from interface scala.concurrent.Future</h3>
<code>andThen, collect, failed, fallbackTo, filter, flatMap, foreach, map, mapTo, onFailure, onSuccess, recover, recoverWith, transform, withFilter, zip</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="cancel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>public void cancel()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#cancel()">FutureAction</a></code></strong></div>
<div class="block">Cancels the execution of this action.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#cancel()">cancel</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
</dl>
</li>
</ul>
<a name="ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ready</h4>
<pre>public <a href="../../../org/apache/spark/SimpleFutureAction.html" title="class in org.apache.spark">SimpleFutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>> ready(scala.concurrent.duration.Duration atMost,
scala.concurrent.CanAwait permit)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">FutureAction</a></code></strong></div>
<div class="block">Blocks until this action completes.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">ready</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>ready</code> in interface <code>scala.concurrent.Awaitable<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>atMost</code> - maximum wait time, which may be negative (no waiting is done), Duration.Inf
for unbounded waiting, or a finite positive duration</dd>
<dt><span class="strong">Returns:</span></dt><dd>this FutureAction</dd></dl>
</li>
</ul>
<a name="result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>result</h4>
<pre>public <a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a> result(scala.concurrent.duration.Duration atMost,
scala.concurrent.CanAwait permit)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">FutureAction</a></code></strong></div>
<div class="block">Awaits and returns the result (of type T) of this action.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">result</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>result</code> in interface <code>scala.concurrent.Awaitable<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>atMost</code> - maximum wait time, which may be negative (no waiting is done), Duration.Inf
for unbounded waiting, or a finite positive duration</dd>
<dt><span class="strong">Returns:</span></dt><dd>the result value if the action is completed within the specific maximum wait time</dd></dl>
</li>
</ul>
<a name="onComplete(scala.Function1, scala.concurrent.ExecutionContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onComplete</h4>
<pre>public <U> void onComplete(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>,U> func,
scala.concurrent.ExecutionContext executor)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#onComplete(scala.Function1, scala.concurrent.ExecutionContext)">FutureAction</a></code></strong></div>
<div class="block">When this action is completed, either through an exception, or a value, applies the provided
function.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#onComplete(scala.Function1, scala.concurrent.ExecutionContext)">onComplete</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>onComplete</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
</dl>
</li>
</ul>
<a name="isCompleted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCompleted</h4>
<pre>public boolean isCompleted()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#isCompleted()">FutureAction</a></code></strong></div>
<div class="block">Returns whether the action has already been completed with a value or an exception.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#isCompleted()">isCompleted</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>isCompleted</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
</dl>
</li>
</ul>
<a name="value()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>value</h4>
<pre>public scala.Option<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>> value()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#value()">FutureAction</a></code></strong></div>
<div class="block">The value of this Future.
<p>
If the future is not completed the returned value will be None. If the future is completed
the value will be Some(Success(t)) if it contains a valid result, or Some(Failure(error)) if
it contains an exception.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#value()">value</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>value</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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><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="../../../org/apache/spark/ShuffleDependency.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/SimpleFutureAction.html" target="_top">Frames</a></li>
<li><a href="SimpleFutureAction.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|
