http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/KafkaFuture.BiConsumer.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/KafkaFuture.BiConsumer.html b/10/javadoc/org/apache/kafka/common/KafkaFuture.BiConsumer.html new file mode 100644 index 0000000..fd1e49e --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/KafkaFuture.BiConsumer.html @@ -0,0 +1,278 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>KafkaFuture.BiConsumer (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<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="KafkaFuture.BiConsumer (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaFuture.BiConsumer.html" target="_top">Frames</a></li> +<li><a href="KafkaFuture.BiConsumer.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">org.apache.kafka.common</div> +<h2 title="Class KafkaFuture.BiConsumer" class="title">Class KafkaFuture.BiConsumer<A,B></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.KafkaFuture.BiConsumer<A,B></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>></dd> +</dl> +<hr> +<br> +<pre>public abstract static class <span class="typeNameLabel">KafkaFuture.BiConsumer<A,B></span> +extends java.lang.Object</pre> +<div class="block">A consumer of two different types of object.</div> +</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="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html#BiConsumer--">BiConsumer</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html#accept-A-B-">accept</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">A</a> a, + <a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">B</a> b)</code> </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="BiConsumer--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BiConsumer</h4> +<pre>public BiConsumer()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="accept-java.lang.Object-java.lang.Object-"> +<!-- --> +</a><a name="accept-A-B-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>accept</h4> +<pre>public abstract void accept(<a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">A</a> a, + <a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">B</a> b)</pre> +</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="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaFuture.BiConsumer.html" target="_top">Frames</a></li> +<li><a href="KafkaFuture.BiConsumer.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>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/KafkaFuture.Function.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/KafkaFuture.Function.html b/10/javadoc/org/apache/kafka/common/KafkaFuture.Function.html new file mode 100644 index 0000000..1885e3e --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/KafkaFuture.Function.html @@ -0,0 +1,276 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>KafkaFuture.Function (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<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="KafkaFuture.Function (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaFuture.Function.html" target="_top">Frames</a></li> +<li><a href="KafkaFuture.Function.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">org.apache.kafka.common</div> +<h2 title="Class KafkaFuture.Function" class="title">Class KafkaFuture.Function<A,B></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.KafkaFuture.Function<A,B></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>></dd> +</dl> +<hr> +<br> +<pre>public abstract static class <span class="typeNameLabel">KafkaFuture.Function<A,B></span> +extends java.lang.Object</pre> +<div class="block">A function which takes objects of type A and returns objects of type B.</div> +</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="../../../../org/apache/kafka/common/KafkaFuture.Function.html#Function--">Function</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract <a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">B</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html#apply-A-">apply</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">A</a> a)</code> </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="Function--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Function</h4> +<pre>public Function()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="apply-java.lang.Object-"> +<!-- --> +</a><a name="apply-A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>apply</h4> +<pre>public abstract <a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">B</a> apply(<a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">A</a> a)</pre> +</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="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaFuture.Function.html" target="_top">Frames</a></li> +<li><a href="KafkaFuture.Function.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> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/KafkaFuture.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/KafkaFuture.html b/10/javadoc/org/apache/kafka/common/KafkaFuture.html new file mode 100644 index 0000000..8ed8a1f --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/KafkaFuture.html @@ -0,0 +1,559 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>KafkaFuture (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<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="KafkaFuture (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"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}; +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"; +</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="../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaFuture.html" target="_top">Frames</a></li> +<li><a href="KafkaFuture.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><a href="#nested.class.summary">Nested</a> | </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">org.apache.kafka.common</div> +<h2 title="Class KafkaFuture" class="title">Class KafkaFuture<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.KafkaFuture<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.concurrent.Future<T></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">@InterfaceStability.Evolving</a> +public abstract class <span class="typeNameLabel">KafkaFuture<T></span> +extends java.lang.Object +implements java.util.concurrent.Future<T></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 ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common">KafkaFuture.BiConsumer</a><<a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">A</a>,<a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="type parameter in KafkaFuture.BiConsumer">B</a>></span></code> +<div class="block">A consumer of two different types of object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a><<a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">A</a>,<a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="type parameter in KafkaFuture.Function">B</a>></span></code> +<div class="block">A function which takes objects of type A and returns objects of type B.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#KafkaFuture--">KafkaFuture</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>protected abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#addWaiter-org.apache.kafka.common.KafkaFuture.BiConsumer-">addWaiter</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common">KafkaFuture.BiConsumer</a><? super <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,? super java.lang.Throwable> action)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.lang.Void></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#allOf-org.apache.kafka.common.KafkaFuture...-">allOf</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><?>... futures)</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#cancel-boolean-">cancel</a></span>(boolean mayInterruptIfRunning)</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#complete-T-">complete</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a> newValue)</code> +<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 <U> <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><U></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#completedFuture-U-">completedFuture</a></span>(U value)</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#completeExceptionally-java.lang.Throwable-">completeExceptionally</a></span>(java.lang.Throwable newException)</code> +<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="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#get--">get</a></span>()</code> +<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="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#get-long-java.util.concurrent.TimeUnit-">get</a></span>(long timeout, + java.util.concurrent.TimeUnit unit)</code> +<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="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#getNow-T-">getNow</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a> valueIfAbsent)</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#isCancelled--">isCancelled</a></span>()</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#isCompletedExceptionally--">isCompletedExceptionally</a></span>()</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#isDone--">isDone</a></span>()</code> +<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 <R> <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><R></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/KafkaFuture.html#thenApply-org.apache.kafka.common.KafkaFuture.Function-">thenApply</a></span>(<a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a><<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,R> function)</code> +<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> +</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="KafkaFuture--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KafkaFuture</h4> +<pre>public KafkaFuture()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="completedFuture-java.lang.Object-"> +<!-- --> +</a><a name="completedFuture-U-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>completedFuture</h4> +<pre>public static <U> <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><U> completedFuture(U value)</pre> +<div class="block">Returns a new KafkaFuture that is already completed with the given value.</div> +</li> +</ul> +<a name="allOf-org.apache.kafka.common.KafkaFuture...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allOf</h4> +<pre>public static <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.lang.Void> allOf(<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><?>... 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 name="thenApply-org.apache.kafka.common.KafkaFuture.Function-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>thenApply</h4> +<pre>public abstract <R> <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><R> thenApply(<a href="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a><<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,R> 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.</div> +</li> +</ul> +<a name="addWaiter-org.apache.kafka.common.KafkaFuture.BiConsumer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addWaiter</h4> +<pre>protected abstract void addWaiter(<a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common">KafkaFuture.BiConsumer</a><? super <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>,? super java.lang.Throwable> action)</pre> +</li> +</ul> +<a name="complete-java.lang.Object-"> +<!-- --> +</a><a name="complete-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>complete</h4> +<pre>protected abstract boolean complete(<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a> 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 name="completeExceptionally-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>completeExceptionally</h4> +<pre>protected abstract boolean completeExceptionally(java.lang.Throwable 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 name="cancel-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancel</h4> +<pre>public abstract boolean cancel(boolean 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>cancel</code> in interface <code>java.util.concurrent.Future<<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public abstract <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a> get() + throws java.lang.InterruptedException, + java.util.concurrent.ExecutionException</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>get</code> in interface <code>java.util.concurrent.Future<<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</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="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public abstract <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</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">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>get</code> in interface <code>java.util.concurrent.Future<<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</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> +<a name="getNow-java.lang.Object-"> +<!-- --> +</a><a name="getNow-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNow</h4> +<pre>public abstract <a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a> getNow(<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a> valueIfAbsent) + throws java.lang.InterruptedException, + java.util.concurrent.ExecutionException</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>java.lang.InterruptedException</code></dd> +<dd><code>java.util.concurrent.ExecutionException</code></dd> +</dl> +</li> +</ul> +<a name="isCancelled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCancelled</h4> +<pre>public abstract boolean 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>isCancelled</code> in interface <code>java.util.concurrent.Future<<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="isCompletedExceptionally--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCompletedExceptionally</h4> +<pre>public abstract boolean isCompletedExceptionally()</pre> +<div class="block">Returns true if this CompletableFuture completed exceptionally, in any way.</div> +</li> +</ul> +<a name="isDone--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isDone</h4> +<pre>public abstract boolean 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>isDone</code> in interface <code>java.util.concurrent.Future<<a href="../../../../org/apache/kafka/common/KafkaFuture.html" title="type parameter in KafkaFuture">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> +<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="../../../../org/apache/kafka/common/KafkaException.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/KafkaFuture.BiConsumer.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/KafkaFuture.html" target="_top">Frames</a></li> +<li><a href="KafkaFuture.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><a href="#nested.class.summary">Nested</a> | </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> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/Metric.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/Metric.html b/10/javadoc/org/apache/kafka/common/Metric.html new file mode 100644 index 0000000..2ceda7e --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/Metric.html @@ -0,0 +1,259 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>Metric (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<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="Metric (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":38}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Metric.html" target="_top">Frames</a></li> +<li><a href="Metric.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.kafka.common</div> +<h2 title="Interface Metric" class="title">Interface Metric</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Metric</span></pre> +<div class="block">A metric tracked for monitoring purposes.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Metric.html#metricName--">metricName</a></span>()</code> +<div class="block">A name for this metric</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Metric.html#metricValue--">metricValue</a></span>()</code> +<div class="block">The value of the metric, which may be measurable or a non-measurable gauge</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/Metric.html#value--">value</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">As of 1.0.0, use <a href="../../../../org/apache/kafka/common/Metric.html#metricValue--"><code>metricValue()</code></a> instead. This will be removed in a future major release.</span></div> +</div> +</td> +</tr> +</table> +</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="metricName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>metricName</h4> +<pre><a href="../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a> metricName()</pre> +<div class="block">A name for this metric</div> +</li> +</ul> +<a name="value--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>value</h4> +<pre>@Deprecated +double value()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of 1.0.0, use <a href="../../../../org/apache/kafka/common/Metric.html#metricValue--"><code>metricValue()</code></a> instead. This will be removed in a future major release.</span></div> +<div class="block">The value of the metric as double if the metric is measurable and `0.0` otherwise.</div> +</li> +</ul> +<a name="metricValue--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>metricValue</h4> +<pre>java.lang.Object metricValue()</pre> +<div class="block">The value of the metric, which may be measurable or a non-measurable gauge</div> +</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="../../../../org/apache/kafka/common/KafkaFuture.Function.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Metric.html" target="_top">Frames</a></li> +<li><a href="Metric.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> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/MetricName.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/MetricName.html b/10/javadoc/org/apache/kafka/common/MetricName.html new file mode 100644 index 0000000..366cce7 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/MetricName.html @@ -0,0 +1,414 @@ +<!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 (1.8.0_152) on Wed Nov 01 13:25:43 GMT 2017 --> +<title>MetricName (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<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="MetricName (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../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/kafka/common/Metric.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/MetricNameTemplate.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/MetricName.html" target="_top">Frames</a></li> +<li><a href="MetricName.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">org.apache.kafka.common</div> +<h2 title="Class MetricName" class="title">Class MetricName</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.MetricName</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">MetricName</span> +extends java.lang.Object</pre> +<div class="block">The <code>MetricName</code> class encapsulates a metric's name, logical group and its related attributes. It should be constructed using metrics.MetricName(...). + <p> + This class captures the following parameters + <pre> + <b>name</b> The name of the metric + <b>group</b> logical group name of the metrics to which this metric belongs. + <b>description</b> A human-readable description to include in the metric. This is optional. + <b>tags</b> additional key/value attributes of the metric. This is optional. + </pre> + group, tags parameters can be used to create unique metric names while reporting in JMX or any custom reporting. + <p> + Ex: standard JMX MBean can be constructed like <b>domainName:type=group,key1=val1,key2=val2</b> + <p> + + Usage looks something like this: + <pre><code> + // set up metrics: + + Map<String, String> metricTags = new LinkedHashMap<String, String>(); + metricTags.put("client-id", "producer-1"); + metricTags.put("topic", "topic"); + + MetricConfig metricConfig = new MetricConfig().tags(metricTags); + Metrics metrics = new Metrics(metricConfig); // this is the global repository of metrics and sensors + + Sensor sensor = metrics.sensor("message-sizes"); + + MetricName metricName = metrics.metricName("message-size-avg", "producer-metrics", "average message size"); + sensor.add(metricName, new Avg()); + + metricName = metrics.metricName("message-size-max", "producer-metrics"); + sensor.add(metricName, new Max()); + + metricName = metrics.metricName("message-size-min", "producer-metrics", "message minimum size", "client-id", "my-client", "topic", "my-topic"); + sensor.add(metricName, new Min()); + + // as messages are sent we record the sizes + sensor.record(messageSize); + </code></pre></div> +</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="../../../../org/apache/kafka/common/MetricName.html#MetricName-java.lang.String-java.lang.String-java.lang.String-java.util.Map-">MetricName</a></span>(java.lang.String name, + java.lang.String group, + java.lang.String description, + java.util.Map<java.lang.String,java.lang.String> tags)</code> +<div class="block">Please create MetricName by method <code>Metrics.metricName(String, String, String, Map)</code></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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#description--">description</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#group--">group</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#name--">name</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#tags--">tags</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kafka/common/MetricName.html#toString--">toString</a></span>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="MetricName-java.lang.String-java.lang.String-java.lang.String-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MetricName</h4> +<pre>public MetricName(java.lang.String name, + java.lang.String group, + java.lang.String description, + java.util.Map<java.lang.String,java.lang.String> tags)</pre> +<div class="block">Please create MetricName by method <code>Metrics.metricName(String, String, String, Map)</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name of the metric</dd> +<dd><code>group</code> - logical group name of the metrics to which this metric belongs</dd> +<dd><code>description</code> - A human-readable description to include in the metric</dd> +<dd><code>tags</code> - additional key/value attributes of the metric</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="name--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>name</h4> +<pre>public java.lang.String name()</pre> +</li> +</ul> +<a name="group--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>group</h4> +<pre>public java.lang.String group()</pre> +</li> +</ul> +<a name="tags--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tags</h4> +<pre>public java.util.Map<java.lang.String,java.lang.String> tags()</pre> +</li> +</ul> +<a name="description--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>description</h4> +<pre>public java.lang.String description()</pre> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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="../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/MetricNameTemplate.html" title="class in org.apache.kafka.common"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/MetricName.html" target="_top">Frames</a></li> +<li><a href="MetricName.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>
