Google Git
Sign in
apache / kafka-site / asf-site / . / 28 / javadoc / org / apache / kafka / common / KafkaFuture.html
blob: 61e5535df2c8de784a5b978eee6ab0db6d07b934 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>KafkaFuture (kafka 2.8.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KafkaFuture (kafka 2.8.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":9,"i2":6,"i3":6,"i4":9,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.kafka.common</a></div>
<h2 title="Class KafkaFuture" class="title">Class KafkaFuture&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.kafka.common.KafkaFuture&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;T&gt;</code></dd>
</dl>
<hr>
<pre><a href="annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">@Evolving</a>
public abstract class <span class="typeNameLabel">KafkaFuture&lt;T&gt;</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;T&gt;</pre>
<div class="block">A flexible future which supports call chaining and other asynchronous programming patterns. This will
eventually become a thin shim on top of Java 8's CompletableFuture.
The API for this class is still evolving and we may break compatibility in minor releases, if necessary.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="KafkaFuture.BaseFunction.html" title="interface in org.apache.kafka.common">KafkaFuture.BaseFunction</a>&lt;<a href="KafkaFuture.BaseFunction.html" title="type parameter in KafkaFuture.BaseFunction">A</a>,&#8203;<a href="KafkaFuture.BaseFunction.html" title="type parameter in KafkaFuture.BaseFunction">B</a>&gt;</span></code></th>
<td class="colLast">
<div class="block">A function which takes objects of type A and returns objects of type B.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="KafkaFuture.BiConsumer.html" title="interface in org.apache.kafka.common">KafkaFuture.BiConsumer</a>&lt;<a href="KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">A</a>,&#8203;<a href="KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">B</a>&gt;</span></code></th>
<td class="colLast">
<div class="block">A consumer of two different types of object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a>&lt;<a href="KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">A</a>,&#8203;<a href="KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">B</a>&gt;</span></code></th>
<td class="colLast">
<div class="block">A function which takes objects of type A and returns objects of type B.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">KafkaFuture</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addWaiter(org.apache.kafka.common.KafkaFuture.BiConsumer)">addWaiter</a></span>&#8203;(<a href="KafkaFuture.BiConsumer.html" title="interface in org.apache.kafka.common">KafkaFuture.BiConsumer</a>&lt;? super <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;? super <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;&nbsp;action)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Void.html?is-external=true" title="class or interface in java.lang" class="externalLink">Void</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allOf(org.apache.kafka.common.KafkaFuture...)">allOf</a></span>&#8203;(<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;?&gt;...&nbsp;futures)</code></th>
<td class="colLast">
<div class="block">Returns a new KafkaFuture that is completed when all the given futures have completed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel(boolean)">cancel</a></span>&#8203;(boolean&nbsp;mayInterruptIfRunning)</code></th>
<td class="colLast">
<div class="block">If not already completed, completes this future with a CancellationException.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#complete(T)">complete</a></span>&#8203;(<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;newValue)</code></th>
<td class="colLast">
<div class="block">If not already completed, sets the value returned by get() and related methods to the given
value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;U&gt;&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;U&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#completedFuture(U)">completedFuture</a></span>&#8203;(U&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Returns a new KafkaFuture that is already completed with the given value.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#completeExceptionally(java.lang.Throwable)">completeExceptionally</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&nbsp;newException)</code></th>
<td class="colLast">
<div class="block">If not already completed, causes invocations of get() and related methods to throw the given
exception.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get()">get</a></span>()</code></th>
<td class="colLast">
<div class="block">Waits if necessary for this future to complete, and then returns its result.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(long,java.util.concurrent.TimeUnit)">get</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Waits if necessary for at most the given time for this future to complete, and then returns
its result, if available.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNow(T)">getNow</a></span>&#8203;(<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;valueIfAbsent)</code></th>
<td class="colLast">
<div class="block">Returns the result value (or throws any encountered exception) if completed, else returns
the given valueIfAbsent.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCancelled()">isCancelled</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if this CompletableFuture was cancelled before it completed normally.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCompletedExceptionally()">isCompletedExceptionally</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if this CompletableFuture completed exceptionally, in any way.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDone()">isDone</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if completed in any fashion: normally, exceptionally, or via cancellation.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract &lt;R&gt;&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;R&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#thenApply(org.apache.kafka.common.KafkaFuture.BaseFunction)">thenApply</a></span>&#8203;(<a href="KafkaFuture.BaseFunction.html" title="interface in org.apache.kafka.common">KafkaFuture.BaseFunction</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;R&gt;&nbsp;function)</code></th>
<td class="colLast">
<div class="block">Returns a new KafkaFuture that, when this future completes normally, is executed with this
futures's result as the argument to the supplied function.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract &lt;R&gt;&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;R&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#thenApply(org.apache.kafka.common.KafkaFuture.Function)">thenApply</a></span>&#8203;(<a href="KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;R&gt;&nbsp;function)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract <a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#whenComplete(org.apache.kafka.common.KafkaFuture.BiConsumer)">whenComplete</a></span>&#8203;(<a href="KafkaFuture.BiConsumer.html" title="interface in org.apache.kafka.common">KafkaFuture.BiConsumer</a>&lt;? super <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;? super <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;&nbsp;action)</code></th>
<td class="colLast">
<div class="block">Returns a new KafkaFuture with the same result or exception as this future, that executes the given action
when this future completes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KafkaFuture</h4>
<pre>public&nbsp;KafkaFuture()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="completedFuture(java.lang.Object)">
<!-- -->
</a><a id="completedFuture(U)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completedFuture</h4>
<pre class="methodSignature">public static&nbsp;&lt;U&gt;&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;U&gt;&nbsp;completedFuture&#8203;(U&nbsp;value)</pre>
<div class="block">Returns a new KafkaFuture that is already completed with the given value.</div>
</li>
</ul>
<a id="allOf(org.apache.kafka.common.KafkaFuture...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Void.html?is-external=true" title="class or interface in java.lang" class="externalLink">Void</a>&gt;&nbsp;allOf&#8203;(<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;?&gt;...&nbsp;futures)</pre>
<div class="block">Returns a new KafkaFuture that is completed when all the given futures have completed. If
any future throws an exception, the returned future returns it. If multiple futures throw
an exception, which one gets returned is arbitrarily chosen.</div>
</li>
</ul>
<a id="thenApply(org.apache.kafka.common.KafkaFuture.BaseFunction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>thenApply</h4>
<pre class="methodSignature">public abstract&nbsp;&lt;R&gt;&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;R&gt;&nbsp;thenApply&#8203;(<a href="KafkaFuture.BaseFunction.html" title="interface in org.apache.kafka.common">KafkaFuture.BaseFunction</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;R&gt;&nbsp;function)</pre>
<div class="block">Returns a new KafkaFuture that, when this future completes normally, is executed with this
futures's result as the argument to the supplied function.
The function may be invoked by the thread that calls <code>thenApply</code> or it may be invoked by the thread that
completes the future.</div>
</li>
</ul>
<a id="thenApply(org.apache.kafka.common.KafkaFuture.Function)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>thenApply</h4>
<pre class="methodSignature">public abstract&nbsp;&lt;R&gt;&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;R&gt;&nbsp;thenApply&#8203;(<a href="KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;R&gt;&nbsp;function)</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#thenApply(org.apache.kafka.common.KafkaFuture.BaseFunction)"><code>Prefer as this function is here for backwards compatibility reasons
and might be deprecated/removed in a future release.</code></a></dd>
</dl>
</li>
</ul>
<a id="whenComplete(org.apache.kafka.common.KafkaFuture.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>whenComplete</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;&nbsp;whenComplete&#8203;(<a href="KafkaFuture.BiConsumer.html" title="interface in org.apache.kafka.common">KafkaFuture.BiConsumer</a>&lt;? super <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;? super <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;&nbsp;action)</pre>
<div class="block">Returns a new KafkaFuture with the same result or exception as this future, that executes the given action
when this future completes.
When this future is done, the given action is invoked with the result (or null if none) and the exception
(or null if none) of this future as arguments.
The returned future is completed when the action returns.
The supplied action should not throw an exception. However, if it does, the following rules apply:
if this future completed normally but the supplied action throws an exception, then the returned future completes
exceptionally with the supplied action's exception.
Or, if this future completed exceptionally and the supplied action throws an exception, then the returned future
completes exceptionally with this future's exception.
The action may be invoked by the thread that calls <code>whenComplete</code> or it may be invoked by the thread that
completes the future.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>action</code> - the action to preform</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new future</dd>
</dl>
</li>
</ul>
<a id="addWaiter(org.apache.kafka.common.KafkaFuture.BiConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWaiter</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;addWaiter&#8203;(<a href="KafkaFuture.BiConsumer.html" title="interface in org.apache.kafka.common">KafkaFuture.BiConsumer</a>&lt;? super <a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,&#8203;? super <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;&nbsp;action)</pre>
</li>
</ul>
<a id="complete(java.lang.Object)">
<!-- -->
</a><a id="complete(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>complete</h4>
<pre class="methodSignature">protected abstract&nbsp;boolean&nbsp;complete&#8203;(<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;newValue)</pre>
<div class="block">If not already completed, sets the value returned by get() and related methods to the given
value.</div>
</li>
</ul>
<a id="completeExceptionally(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completeExceptionally</h4>
<pre class="methodSignature">protected abstract&nbsp;boolean&nbsp;completeExceptionally&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&nbsp;newException)</pre>
<div class="block">If not already completed, causes invocations of get() and related methods to throw the given
exception.</div>
</li>
</ul>
<a id="cancel(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;cancel&#8203;(boolean&nbsp;mayInterruptIfRunning)</pre>
<div class="block">If not already completed, completes this future with a CancellationException. Dependent
futures that have not already completed will also complete exceptionally, with a
CompletionException caused by this CancellationException.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true#cancel(boolean)" title="class or interface in java.util.concurrent" class="externalLink">cancel</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;get()
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a>,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutionException</a></pre>
<div class="block">Waits if necessary for this future to complete, and then returns its result.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true#get()" title="class or interface in java.util.concurrent" class="externalLink">get</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutionException</a></code></dd>
</dl>
</li>
</ul>
<a id="get(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;get&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a>,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutionException</a>,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeoutException</a></pre>
<div class="block">Waits if necessary for at most the given time for this future to complete, and then returns
its result, if available.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true#get(long,java.util.concurrent.TimeUnit)" title="class or interface in java.util.concurrent" class="externalLink">get</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutionException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeoutException</a></code></dd>
</dl>
</li>
</ul>
<a id="getNow(java.lang.Object)">
<!-- -->
</a><a id="getNow(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNow</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;getNow&#8203;(<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&nbsp;valueIfAbsent)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a>,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutionException</a></pre>
<div class="block">Returns the result value (or throws any encountered exception) if completed, else returns
the given valueIfAbsent.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutionException</a></code></dd>
</dl>
</li>
</ul>
<a id="isCancelled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCancelled</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isCancelled()</pre>
<div class="block">Returns true if this CompletableFuture was cancelled before it completed normally.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true#isCancelled()" title="class or interface in java.util.concurrent" class="externalLink">isCancelled</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="isCompletedExceptionally()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCompletedExceptionally</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isCompletedExceptionally()</pre>
<div class="block">Returns true if this CompletableFuture completed exceptionally, in any way.</div>
</li>
</ul>
<a id="isDone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isDone</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isDone()</pre>
<div class="block">Returns true if completed in any fashion: normally, exceptionally, or via cancellation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true#isDone()" title="class or interface in java.util.concurrent" class="externalLink">isDone</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="KafkaFuture.html" title="type parameter in KafkaFuture">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>