http://git-wip-us.apache.org/repos/asf/kafka-site/blob/b91f7909/0100/javadoc/org/apache/kafka/common/MetricName.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/common/MetricName.html b/0100/javadoc/org/apache/kafka/common/MetricName.html new file mode 100644 index 0000000..1ce7280 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/common/MetricName.html @@ -0,0 +1,492 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>MetricName (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricName (clients 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common"><span class="strong">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="strong">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="overviewSummary" 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><strong><a href="../../../../org/apache/kafka/common/MetricName.html#MetricName(java.lang.String,%20java.lang.String)">MetricName</a></strong>(java.lang.String name, + java.lang.String group)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String)</code></i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#MetricName(java.lang.String,%20java.lang.String,%20java.util.Map)">MetricName</a></strong>(java.lang.String name, + java.lang.String group, + java.util.Map<java.lang.String,java.lang.String> tags)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String, Map)</code></i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#MetricName(java.lang.String,%20java.lang.String,%20java.lang.String)">MetricName</a></strong>(java.lang.String name, + java.lang.String group, + java.lang.String description)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String, String)</code></i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#MetricName(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.util.Map)">MetricName</a></strong>(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> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#MetricName(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String...)">MetricName</a></strong>(java.lang.String name, + java.lang.String group, + java.lang.String description, + java.lang.String... keyValue)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String, String, String...)</code></i></div> +</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#description()">description</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#group()">group</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#name()">name</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#tags()">tags</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/MetricName.html#toString()">toString</a></strong>()</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="blockList"> +<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="strong">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> +<a name="MetricName(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MetricName</h4> +<pre>@Deprecated +public MetricName(java.lang.String name, + java.lang.String group, + java.lang.String description, + java.lang.String... keyValue)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String, String, String...)</code></i></div> +<dl><dt><span class="strong">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>keyValue</code> - additional key/value attributes of the metric (must come in pairs)</dd></dl> +</li> +</ul> +<a name="MetricName(java.lang.String, java.lang.String, java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MetricName</h4> +<pre>@Deprecated +public MetricName(java.lang.String name, + java.lang.String group, + java.util.Map<java.lang.String,java.lang.String> tags)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String, Map)</code></i></div> +<dl><dt><span class="strong">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>tags</code> - key/value attributes of the metric</dd></dl> +</li> +</ul> +<a name="MetricName(java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MetricName</h4> +<pre>@Deprecated +public MetricName(java.lang.String name, + java.lang.String group, + java.lang.String description)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String, String)</code></i></div> +<dl><dt><span class="strong">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></dl> +</li> +</ul> +<a name="MetricName(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MetricName</h4> +<pre>@Deprecated +public MetricName(java.lang.String name, + java.lang.String group)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This method will be removed in a future release. + Please create MetricName by method <code>Metrics.metricName(String, String)</code></i></div> +<dl><dt><span class="strong">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></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><strong>Overrides:</strong></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><strong>Overrides:</strong></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><strong>Overrides:</strong></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/Metric.html" title="interface in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common"><span class="strong">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>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/b91f7909/0100/javadoc/org/apache/kafka/common/Node.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/common/Node.html b/0100/javadoc/org/apache/kafka/common/Node.html new file mode 100644 index 0000000..a11c8f6 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/common/Node.html @@ -0,0 +1,444 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>Node (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Node (clients 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Node.html" target="_top">Frames</a></li> +<li><a href="Node.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 Node" class="title">Class Node</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.Node</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Node</span> +extends java.lang.Object</pre> +<div class="block">Information about a Kafka node</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="overviewSummary" 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><strong><a href="../../../../org/apache/kafka/common/Node.html#Node(int,%20java.lang.String,%20int)">Node</a></strong>(int id, + java.lang.String host, + int port)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#Node(int,%20java.lang.String,%20int,%20java.lang.String)">Node</a></strong>(int id, + java.lang.String host, + int port, + java.lang.String rack)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#hasRack()">hasRack</a></strong>()</code> +<div class="block">True if this node has a defined rack</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#host()">host</a></strong>()</code> +<div class="block">The host name for this node</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#id()">id</a></strong>()</code> +<div class="block">The node id of this node</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#idString()">idString</a></strong>()</code> +<div class="block">String representation of the node id.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#isEmpty()">isEmpty</a></strong>()</code> +<div class="block">Check whether this node is empty, which may be the case if noNode() is used as a placeholder + in a response payload with an error.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#noNode()">noNode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#port()">port</a></strong>()</code> +<div class="block">The port for this node</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#rack()">rack</a></strong>()</code> +<div class="block">The rack for this node</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/Node.html#toString()">toString</a></strong>()</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="Node(int, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Node</h4> +<pre>public Node(int id, + java.lang.String host, + int port)</pre> +</li> +</ul> +<a name="Node(int, java.lang.String, int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Node</h4> +<pre>public Node(int id, + java.lang.String host, + int port, + java.lang.String rack)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="noNode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noNode</h4> +<pre>public static <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> noNode()</pre> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<div class="block">Check whether this node is empty, which may be the case if noNode() is used as a placeholder + in a response payload with an error.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if it is, false otherwise</dd></dl> +</li> +</ul> +<a name="id()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>id</h4> +<pre>public int id()</pre> +<div class="block">The node id of this node</div> +</li> +</ul> +<a name="idString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>idString</h4> +<pre>public java.lang.String idString()</pre> +<div class="block">String representation of the node id. + Typically the integer id is used to serialize over the wire, the string representation is used as an identifier with NetworkClient code</div> +</li> +</ul> +<a name="host()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>host</h4> +<pre>public java.lang.String host()</pre> +<div class="block">The host name for this node</div> +</li> +</ul> +<a name="port()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>port</h4> +<pre>public int port()</pre> +<div class="block">The port for this node</div> +</li> +</ul> +<a name="hasRack()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRack</h4> +<pre>public boolean hasRack()</pre> +<div class="block">True if this node has a defined rack</div> +</li> +</ul> +<a name="rack()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rack</h4> +<pre>public java.lang.String rack()</pre> +<div class="block">The rack for this node</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></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><strong>Overrides:</strong></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><strong>Overrides:</strong></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/MetricName.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/Node.html" target="_top">Frames</a></li> +<li><a href="Node.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/b91f7909/0100/javadoc/org/apache/kafka/common/PartitionInfo.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/common/PartitionInfo.html b/0100/javadoc/org/apache/kafka/common/PartitionInfo.html new file mode 100644 index 0000000..0775be3 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/common/PartitionInfo.html @@ -0,0 +1,349 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>PartitionInfo (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="PartitionInfo (clients 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/PartitionInfo.html" target="_top">Frames</a></li> +<li><a href="PartitionInfo.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 PartitionInfo" class="title">Class PartitionInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.PartitionInfo</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">PartitionInfo</span> +extends java.lang.Object</pre> +<div class="block">Information about a topic-partition.</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="overviewSummary" 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><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#PartitionInfo(java.lang.String,%20int,%20org.apache.kafka.common.Node,%20org.apache.kafka.common.Node[],%20org.apache.kafka.common.Node[])">PartitionInfo</a></strong>(java.lang.String topic, + int partition, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> leader, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[] replicas, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[] inSyncReplicas)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#inSyncReplicas()">inSyncReplicas</a></strong>()</code> +<div class="block">The subset of the replicas that are in sync, that is caught-up to the leader and ready to take over as leader if + the leader should fail</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#leader()">leader</a></strong>()</code> +<div class="block">The node id of the node currently acting as a leader for this partition or null if there is no leader</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#partition()">partition</a></strong>()</code> +<div class="block">The partition id</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#replicas()">replicas</a></strong>()</code> +<div class="block">The complete set of replicas for this partition regardless of whether they are alive or up-to-date</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#topic()">topic</a></strong>()</code> +<div class="block">The topic name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/PartitionInfo.html#toString()">toString</a></strong>()</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, 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="PartitionInfo(java.lang.String, int, org.apache.kafka.common.Node, org.apache.kafka.common.Node[], org.apache.kafka.common.Node[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PartitionInfo</h4> +<pre>public PartitionInfo(java.lang.String topic, + int partition, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> leader, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[] replicas, + <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[] inSyncReplicas)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="topic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>topic</h4> +<pre>public java.lang.String topic()</pre> +<div class="block">The topic name</div> +</li> +</ul> +<a name="partition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partition</h4> +<pre>public int partition()</pre> +<div class="block">The partition id</div> +</li> +</ul> +<a name="leader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leader</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a> leader()</pre> +<div class="block">The node id of the node currently acting as a leader for this partition or null if there is no leader</div> +</li> +</ul> +<a name="replicas()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replicas</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[] replicas()</pre> +<div class="block">The complete set of replicas for this partition regardless of whether they are alive or up-to-date</div> +</li> +</ul> +<a name="inSyncReplicas()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>inSyncReplicas</h4> +<pre>public <a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common">Node</a>[] inSyncReplicas()</pre> +<div class="block">The subset of the replicas that are in sync, that is caught-up to the leader and ready to take over as leader if + the leader should fail</div> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/Node.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kafka/common/TopicPartition.html" title="class in org.apache.kafka.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/PartitionInfo.html" target="_top">Frames</a></li> +<li><a href="PartitionInfo.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/b91f7909/0100/javadoc/org/apache/kafka/common/TopicPartition.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/common/TopicPartition.html b/0100/javadoc/org/apache/kafka/common/TopicPartition.html new file mode 100644 index 0000000..948c603 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/common/TopicPartition.html @@ -0,0 +1,327 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>TopicPartition (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TopicPartition (clients 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/TopicPartition.html" target="_top">Frames</a></li> +<li><a href="TopicPartition.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 TopicPartition" class="title">Class TopicPartition</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.common.TopicPartition</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public final class <span class="strong">TopicPartition</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">A topic name and partition number</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.kafka.common.TopicPartition">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/kafka/common/TopicPartition.html#TopicPartition(java.lang.String,%20int)">TopicPartition</a></strong>(java.lang.String topic, + int partition)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/TopicPartition.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/TopicPartition.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/TopicPartition.html#partition()">partition</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/TopicPartition.html#topic()">topic</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kafka/common/TopicPartition.html#toString()">toString</a></strong>()</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="TopicPartition(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TopicPartition</h4> +<pre>public TopicPartition(java.lang.String topic, + int partition)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="partition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>partition</h4> +<pre>public int partition()</pre> +</li> +</ul> +<a name="topic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>topic</h4> +<pre>public java.lang.String topic()</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></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><strong>Overrides:</strong></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><strong>Overrides:</strong></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kafka/common/PartitionInfo.html" title="class in org.apache.kafka.common"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kafka/common/TopicPartition.html" target="_top">Frames</a></li> +<li><a href="TopicPartition.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/b91f7909/0100/javadoc/org/apache/kafka/common/config/AbstractConfig.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/common/config/AbstractConfig.html b/0100/javadoc/org/apache/kafka/common/config/AbstractConfig.html new file mode 100644 index 0000000..78c56cf --- /dev/null +++ b/0100/javadoc/org/apache/kafka/common/config/AbstractConfig.html @@ -0,0 +1,590 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue May 17 21:36:37 PDT 2016 --> +<title>AbstractConfig (clients 0.10.0.0 API)</title> +<meta name="date" content="2016-05-17"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractConfig (clients 0.10.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/common/config/Config.html" title="class in org.apache.kafka.common.config"><span class="strong">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/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></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">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="overviewSummary" 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><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#AbstractConfig(org.apache.kafka.common.config.ConfigDef,%20java.util.Map)">AbstractConfig</a></strong>(<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><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#AbstractConfig(org.apache.kafka.common.config.ConfigDef,%20java.util.Map,%20boolean)">AbstractConfig</a></strong>(<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> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#AbstractConfig(java.util.Map)">AbstractConfig</a></strong>(java.util.Map<java.lang.String,java.lang.Object> parsedConfig)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#get(java.lang.String)">get</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getBoolean(java.lang.String)">getBoolean</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getClass(java.lang.String)">getClass</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstance(java.lang.String,%20java.lang.Class)">getConfiguredInstance</a></strong>(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 class="rowColor"> +<td class="colFirst"><code><T> java.util.List<T></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getConfiguredInstances(java.lang.String,%20java.lang.Class)">getConfiguredInstances</a></strong>(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 class="altColor"> +<td class="colFirst"><code>java.lang.Double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getDouble(java.lang.String)">getDouble</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getInt(java.lang.String)">getInt</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getList(java.lang.String)">getList</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getLong(java.lang.String)">getLong</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.kafka.common.config.types.Password</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getPassword(java.lang.String)">getPassword</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Short</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getShort(java.lang.String)">getShort</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#getString(java.lang.String)">getString</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#ignore(java.lang.String)">ignore</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#logUnused()">logUnused</a></strong>()</code> +<div class="block">Log warnings for any unused configurations</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originals()">originals</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsStrings()">originalsStrings</a></strong>()</code> +<div class="block">Get all the original settings, ensuring that all values are of type String.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#originalsWithPrefix(java.lang.String)">originalsWithPrefix</a></strong>(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 class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#unused()">unused</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,?></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/common/config/AbstractConfig.html#values()">values</a></strong>()</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, 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="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)</pre> +</li> +</ul> +<a name="AbstractConfig(java.util.Map)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractConfig</h4> +<pre>public AbstractConfig(java.util.Map<java.lang.String,java.lang.Object> parsedConfig)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<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="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="strong">Returns:</span></dt><dd>the original settings</dd> +<dt><span class="strong">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="strong">Parameters:</span></dt><dd><code>prefix</code> - the prefix to use as a filter</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Map containing the settings with the prefix</dd></dl> +</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="strong">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="strong">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="strong">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="strong">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><strong>Overrides:</strong></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><strong>Overrides:</strong></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/common/config/Config.html" title="class in org.apache.kafka.common.config"><span class="strong">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>
