http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/annotation/InterfaceStability.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/annotation/InterfaceStability.html b/10/javadoc/org/apache/kafka/common/annotation/InterfaceStability.html new file mode 100644 index 0000000..7bf12ba --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/annotation/InterfaceStability.html @@ -0,0 +1,272 @@ +<!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:42 GMT 2017 --> +<title>InterfaceStability (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="InterfaceStability (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +</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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/annotation/InterfaceStability.html" target="_top">Frames</a></li> +<li><a href="InterfaceStability.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="#methods.inherited.from.class.java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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.annotation</div> +<h2 title="Class InterfaceStability" class="title">Class InterfaceStability</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.annotation.InterfaceStability</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<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 class <span class="typeNameLabel">InterfaceStability</span> +extends java.lang.Object</pre> +<div class="block">Annotation to inform users of how much to rely on a particular package, class or method not changing over time. + Currently the stability can be <a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Stable.html" title="annotation in org.apache.kafka.common.annotation"><code>InterfaceStability.Stable</code></a>, <a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation"><code>InterfaceStability.Evolving</code></a> or <a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.kafka.common.annotation"><code>InterfaceStability.Unstable</code></a>.</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 interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">InterfaceStability.Evolving</a></span></code> +<div class="block">Compatibility may be broken at minor release (i.e.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Stable.html" title="annotation in org.apache.kafka.common.annotation">InterfaceStability.Stable</a></span></code> +<div class="block">Compatibility is maintained in major, minor and patch releases with one exception: compatibility may be broken + in a major release (i.e.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.kafka.common.annotation">InterfaceStability.Unstable</a></span></code> +<div class="block">No guarantee is provided as to reliability or stability across any level of release granularity.</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/annotation/InterfaceStability.html#InterfaceStability--">InterfaceStability</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> +<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="InterfaceStability--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InterfaceStability</h4> +<pre>public InterfaceStability()</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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/annotation/InterfaceStability.html" target="_top">Frames</a></li> +<li><a href="InterfaceStability.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="#methods.inherited.from.class.java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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/annotation/package-frame.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/annotation/package-frame.html b/10/javadoc/org/apache/kafka/common/annotation/package-frame.html new file mode 100644 index 0000000..a423b43 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/annotation/package-frame.html @@ -0,0 +1,26 @@ +<!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:44 GMT 2017 --> +<title>org.apache.kafka.common.annotation (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> +<h1 class="bar"><a href="../../../../../org/apache/kafka/common/annotation/package-summary.html" target="classFrame">org.apache.kafka.common.annotation</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="InterfaceStability.html" title="class in org.apache.kafka.common.annotation" target="classFrame">InterfaceStability</a></li> +</ul> +<h2 title="Annotation Types">Annotation Types</h2> +<ul title="Annotation Types"> +<li><a href="InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation" target="classFrame">InterfaceStability.Evolving</a></li> +<li><a href="InterfaceStability.Stable.html" title="annotation in org.apache.kafka.common.annotation" target="classFrame">InterfaceStability.Stable</a></li> +<li><a href="InterfaceStability.Unstable.html" title="annotation in org.apache.kafka.common.annotation" target="classFrame">InterfaceStability.Unstable</a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/common/annotation/package-summary.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/annotation/package-summary.html b/10/javadoc/org/apache/kafka/common/annotation/package-summary.html new file mode 100644 index 0000000..65de784 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/annotation/package-summary.html @@ -0,0 +1,172 @@ +<!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:44 GMT 2017 --> +<title>org.apache.kafka.common.annotation (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="org.apache.kafka.common.annotation (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>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/acl/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/kafka/common/config/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/annotation/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.kafka.common.annotation</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.html" title="class in org.apache.kafka.common.annotation">InterfaceStability</a></td> +<td class="colLast"> +<div class="block">Annotation to inform users of how much to rely on a particular package, class or method not changing over time.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> +<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Annotation Type</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">InterfaceStability.Evolving</a></td> +<td class="colLast"> +<div class="block">Compatibility may be broken at minor release (i.e.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Stable.html" title="annotation in org.apache.kafka.common.annotation">InterfaceStability.Stable</a></td> +<td class="colLast"> +<div class="block">Compatibility is maintained in major, minor and patch releases with one exception: compatibility may be broken + in a major release (i.e.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.kafka.common.annotation">InterfaceStability.Unstable</a></td> +<td class="colLast"> +<div class="block">No guarantee is provided as to reliability or stability across any level of release granularity.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/acl/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/kafka/common/config/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/annotation/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<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/annotation/package-tree.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/annotation/package-tree.html b/10/javadoc/org/apache/kafka/common/annotation/package-tree.html new file mode 100644 index 0000000..42a5272 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/annotation/package-tree.html @@ -0,0 +1,141 @@ +<!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:44 GMT 2017 --> +<title>org.apache.kafka.common.annotation Class Hierarchy (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="org.apache.kafka.common.annotation Class Hierarchy (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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/acl/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/kafka/common/config/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/annotation/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.kafka.common.annotation</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.kafka.common.annotation.<a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.html" title="class in org.apache.kafka.common.annotation"><span class="typeNameLink">InterfaceStability</span></a></li> +</ul> +</li> +</ul> +<h2 title="Annotation Type Hierarchy">Annotation Type Hierarchy</h2> +<ul> +<li type="circle">org.apache.kafka.common.annotation.<a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.kafka.common.annotation"><span class="typeNameLink">InterfaceStability.Unstable</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">org.apache.kafka.common.annotation.<a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Stable.html" title="annotation in org.apache.kafka.common.annotation"><span class="typeNameLink">InterfaceStability.Stable</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">org.apache.kafka.common.annotation.<a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation"><span class="typeNameLink">InterfaceStability.Evolving</span></a> (implements java.lang.annotation.Annotation)</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/acl/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/kafka/common/config/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/annotation/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<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/config/AbstractConfig.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/config/AbstractConfig.html b/10/javadoc/org/apache/kafka/common/config/AbstractConfig.html new file mode 100644 index 0000000..1f3e785 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/config/AbstractConfig.html @@ -0,0 +1,696 @@ +<!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>AbstractConfig (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="AbstractConfig (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/common/config/Config.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/config/AbstractConfig.html" target="_top">Frames</a></li> +<li><a href="AbstractConfig.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.config</div> +<h2 title="Class AbstractConfig" class="title">Class AbstractConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.config.AbstractConfig</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/kafka/clients/admin/AdminClientConfig.html" title="class in org.apache.kafka.clients.admin">AdminClientConfig</a>, <a href="../../../../../org/apache/kafka/clients/consumer/ConsumerConfig.html" title="class in org.apache.kafka.clients.consumer">ConsumerConfig</a>, <a href="../../../../../org/apache/kafka/clients/producer/ProducerConfig.html" title="class in org.apache.kafka.clients.producer">ProducerConfig</a>, <a href="../../../../../org/apache/kafka/streams/StreamsConfig.html" title="class in org.apache.kafka.streams">StreamsConfig</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AbstractConfig</span> +extends java.lang.Object</pre> +<div class="block">A convenient base class for configurations to extend. + <p> + This class holds both the original configuration that was provided as well as the parsed</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/config/AbstractConfig.html#AbstractConfig-org.apache.kafka.common.config.ConfigDef-java.util.Map-">AbstractConfig</a></span>(<a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> definition, + java.util.Map<?,?> originals)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#AbstractConfig-org.apache.kafka.common.config.ConfigDef-java.util.Map-boolean-">AbstractConfig</a></span>(<a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> definition, + java.util.Map<?,?> originals, + boolean doLog)</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#get-java.lang.String-">get</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getBoolean-java.lang.String-">getBoolean</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getClass-java.lang.String-">getClass</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstance-java.lang.String-java.lang.Class-">getConfiguredInstance</a></span>(java.lang.String key, + java.lang.Class<T> t)</code> +<div class="block">Get a configured instance of the give class specified by the given configuration key.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><T> java.util.List<T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstances-java.lang.String-java.lang.Class-">getConfiguredInstances</a></span>(java.lang.String key, + java.lang.Class<T> t)</code> +<div class="block">Get a list of configured instances of the given class specified by the given configuration key.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><T> java.util.List<T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstances-java.lang.String-java.lang.Class-java.util.Map-">getConfiguredInstances</a></span>(java.lang.String key, + java.lang.Class<T> t, + java.util.Map<java.lang.String,java.lang.Object> configOverrides)</code> +<div class="block">Get a list of configured instances of the given class specified by the given configuration key.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.Double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getDouble-java.lang.String-">getDouble</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getInt-java.lang.String-">getInt</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getList-java.lang.String-">getList</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getLong-java.lang.String-">getLong</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>org.apache.kafka.common.config.types.Password</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getPassword-java.lang.String-">getPassword</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>java.lang.Short</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getShort-java.lang.String-">getShort</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getString-java.lang.String-">getString</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#ignore-java.lang.String-">ignore</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#logUnused--">logUnused</a></span>()</code> +<div class="block">Log warnings for any unused configurations</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originals--">originals</a></span>()</code> </td> +</tr> +<tr id="i18" class="altColor"> +<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/config/AbstractConfig.html#originalsStrings--">originalsStrings</a></span>()</code> +<div class="block">Get all the original settings, ensuring that all values are of type String.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsWithPrefix-java.lang.String-">originalsWithPrefix</a></span>(java.lang.String prefix)</code> +<div class="block">Gets all original settings with the given prefix, stripping the prefix before adding it to the output.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#postProcessParsedConfig-java.util.Map-">postProcessParsedConfig</a></span>(java.util.Map<java.lang.String,java.lang.Object> parsedValues)</code> +<div class="block">Called directly after user configs got parsed (and thus default values got set).</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/config/ConfigDef.Type.html" title="enum in org.apache.kafka.common.config">ConfigDef.Type</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#typeOf-java.lang.String-">typeOf</a></span>(java.lang.String key)</code> </td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#unused--">unused</a></span>()</code> </td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#values--">values</a></span>()</code> </td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#valuesWithPrefixOverride-java.lang.String-">valuesWithPrefixOverride</a></span>(java.lang.String prefix)</code> +<div class="block">Put all keys that do not start with <code>prefix</code> and their parsed values in the result map and then + put all the remaining keys with the prefix stripped and their parsed values in the result map.</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, finalize, getClass, 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="AbstractConfig-org.apache.kafka.common.config.ConfigDef-java.util.Map-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbstractConfig</h4> +<pre>public AbstractConfig(<a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> definition, + java.util.Map<?,?> originals, + boolean doLog)</pre> +</li> +</ul> +<a name="AbstractConfig-org.apache.kafka.common.config.ConfigDef-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractConfig</h4> +<pre>public AbstractConfig(<a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> definition, + java.util.Map<?,?> originals)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="postProcessParsedConfig-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>postProcessParsedConfig</h4> +<pre>protected java.util.Map<java.lang.String,java.lang.Object> postProcessParsedConfig(java.util.Map<java.lang.String,java.lang.Object> parsedValues)</pre> +<div class="block">Called directly after user configs got parsed (and thus default values got set). + This allows to change default values for "secondary defaults" if required.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parsedValues</code> - unmodifiable map of current configuration</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a map of updates that should be applied to the configuration (will be validated to prevent bad updates)</dd> +</dl> +</li> +</ul> +<a name="get-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>protected java.lang.Object get(java.lang.String key)</pre> +</li> +</ul> +<a name="ignore-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ignore</h4> +<pre>public void ignore(java.lang.String key)</pre> +</li> +</ul> +<a name="getShort-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShort</h4> +<pre>public java.lang.Short getShort(java.lang.String key)</pre> +</li> +</ul> +<a name="getInt-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public java.lang.Integer getInt(java.lang.String key)</pre> +</li> +</ul> +<a name="getLong-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLong</h4> +<pre>public java.lang.Long getLong(java.lang.String key)</pre> +</li> +</ul> +<a name="getDouble-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public java.lang.Double getDouble(java.lang.String key)</pre> +</li> +</ul> +<a name="getList-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getList</h4> +<pre>public java.util.List<java.lang.String> getList(java.lang.String key)</pre> +</li> +</ul> +<a name="getBoolean-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public java.lang.Boolean getBoolean(java.lang.String key)</pre> +</li> +</ul> +<a name="getString-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String key)</pre> +</li> +</ul> +<a name="typeOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>typeOf</h4> +<pre>public <a href="../../../../../org/apache/kafka/common/config/ConfigDef.Type.html" title="enum in org.apache.kafka.common.config">ConfigDef.Type</a> typeOf(java.lang.String key)</pre> +</li> +</ul> +<a name="getPassword-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPassword</h4> +<pre>public org.apache.kafka.common.config.types.Password getPassword(java.lang.String key)</pre> +</li> +</ul> +<a name="getClass-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClass</h4> +<pre>public java.lang.Class<?> getClass(java.lang.String key)</pre> +</li> +</ul> +<a name="unused--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unused</h4> +<pre>public java.util.Set<java.lang.String> unused()</pre> +</li> +</ul> +<a name="originals--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>originals</h4> +<pre>public java.util.Map<java.lang.String,java.lang.Object> originals()</pre> +</li> +</ul> +<a name="originalsStrings--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>originalsStrings</h4> +<pre>public java.util.Map<java.lang.String,java.lang.String> originalsStrings()</pre> +<div class="block">Get all the original settings, ensuring that all values are of type String.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the original settings</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.ClassCastException</code> - if any of the values are not strings</dd> +</dl> +</li> +</ul> +<a name="originalsWithPrefix-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>originalsWithPrefix</h4> +<pre>public java.util.Map<java.lang.String,java.lang.Object> originalsWithPrefix(java.lang.String prefix)</pre> +<div class="block">Gets all original settings with the given prefix, stripping the prefix before adding it to the output.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>prefix</code> - the prefix to use as a filter</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a Map containing the settings with the prefix</dd> +</dl> +</li> +</ul> +<a name="valuesWithPrefixOverride-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valuesWithPrefixOverride</h4> +<pre>public java.util.Map<java.lang.String,java.lang.Object> valuesWithPrefixOverride(java.lang.String prefix)</pre> +<div class="block">Put all keys that do not start with <code>prefix</code> and their parsed values in the result map and then + put all the remaining keys with the prefix stripped and their parsed values in the result map. + + This is useful if one wants to allow prefixed configs to override default ones.</div> +</li> +</ul> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public java.util.Map<java.lang.String,?> values()</pre> +</li> +</ul> +<a name="logUnused--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logUnused</h4> +<pre>public void logUnused()</pre> +<div class="block">Log warnings for any unused configurations</div> +</li> +</ul> +<a name="getConfiguredInstance-java.lang.String-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguredInstance</h4> +<pre>public <T> T getConfiguredInstance(java.lang.String key, + java.lang.Class<T> t)</pre> +<div class="block">Get a configured instance of the give class specified by the given configuration key. If the object implements + Configurable configure it using the configuration.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - The configuration key for the class</dd> +<dd><code>t</code> - The interface the class should implement</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A configured instance of the class</dd> +</dl> +</li> +</ul> +<a name="getConfiguredInstances-java.lang.String-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguredInstances</h4> +<pre>public <T> java.util.List<T> getConfiguredInstances(java.lang.String key, + java.lang.Class<T> t)</pre> +<div class="block">Get a list of configured instances of the given class specified by the given configuration key. The configuration + may specify either null or an empty string to indicate no configured instances. In both cases, this method + returns an empty list to indicate no configured instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - The configuration key for the class</dd> +<dd><code>t</code> - The interface the class should implement</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The list of configured instances</dd> +</dl> +</li> +</ul> +<a name="getConfiguredInstances-java.lang.String-java.lang.Class-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguredInstances</h4> +<pre>public <T> java.util.List<T> getConfiguredInstances(java.lang.String key, + java.lang.Class<T> t, + java.util.Map<java.lang.String,java.lang.Object> configOverrides)</pre> +<div class="block">Get a list of configured instances of the given class specified by the given configuration key. The configuration + may specify either null or an empty string to indicate no configured instances. In both cases, this method + returns an empty list to indicate no configured instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - The configuration key for the class</dd> +<dd><code>t</code> - The interface the class should implement</dd> +<dd><code>configOverrides</code> - Configuration overrides to use.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The list of configured instances</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 o)</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="hashCode--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +</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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/common/config/Config.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/config/AbstractConfig.html" target="_top">Frames</a></li> +<li><a href="AbstractConfig.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/config/Config.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/common/config/Config.html b/10/javadoc/org/apache/kafka/common/config/Config.html new file mode 100644 index 0000000..63ec6a7 --- /dev/null +++ b/10/javadoc/org/apache/kafka/common/config/Config.html @@ -0,0 +1,269 @@ +<!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>Config (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="Config (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/config/AbstractConfig.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/config/Config.html" target="_top">Frames</a></li> +<li><a href="Config.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.config</div> +<h2 title="Class Config" class="title">Class Config</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.config.Config</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Config</span> +extends java.lang.Object</pre> +</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/config/Config.html#Config-java.util.List-">Config</a></span>(java.util.List<<a href="../../../../../org/apache/kafka/common/config/ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>> configValues)</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="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.util.List<<a href="../../../../../org/apache/kafka/common/config/ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/common/config/Config.html#configValues--">configValues</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, 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="Config-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Config</h4> +<pre>public Config(java.util.List<<a href="../../../../../org/apache/kafka/common/config/ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>> configValues)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="configValues--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>configValues</h4> +<pre>public java.util.List<<a href="../../../../../org/apache/kafka/common/config/ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>> configValues()</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/config/AbstractConfig.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/common/config/ConfigDef.html" title="class in org.apache.kafka.common.config"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/common/config/Config.html" target="_top">Frames</a></li> +<li><a href="Config.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>
