http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/KeyValueMapper.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/KeyValueMapper.html b/0100/javadoc/org/apache/kafka/streams/kstream/KeyValueMapper.html new file mode 100644 index 0000000..8e9d786 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/KeyValueMapper.html @@ -0,0 +1,215 @@ +<!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_80) on Thu May 19 00:52:04 BST 2016 --> +<title>KeyValueMapper (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="KeyValueMapper (kafka 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/streams/kstream/JoinWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/KGroupedTable.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/KeyValueMapper.html" target="_top">Frames</a></li> +<li><a href="KeyValueMapper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Interface KeyValueMapper" class="title">Interface KeyValueMapper<K,V,R></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - original key type</dd><dd><code>V</code> - original value type</dd><dd><code>R</code> - mapped value type</dd></dl> +<hr> +<br> +<pre>public interface <span class="strong">KeyValueMapper<K,V,R></span></pre> +<div class="block">The <a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html" title="interface in org.apache.kafka.streams.kstream"><code>KeyValueMapper</code></a> interface for mapping a key-value pair to a new value (could be another key-value pair).</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/streams/kstream/KeyValueMapper.html" title="type parameter in KeyValueMapper">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html#apply(K,%20V)">apply</a></strong>(<a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html" title="type parameter in KeyValueMapper">K</a> key, + <a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html" title="type parameter in KeyValueMapper">V</a> value)</code> +<div class="block">Map a record with the given key and value to a new value.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="apply(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="apply(K, V)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>apply</h4> +<pre><a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html" title="type parameter in KeyValueMapper">R</a> apply(<a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html" title="type parameter in KeyValueMapper">K</a> key, + <a href="../../../../../org/apache/kafka/streams/kstream/KeyValueMapper.html" title="type parameter in KeyValueMapper">V</a> value)</pre> +<div class="block">Map a record with the given key and value to a new value.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the record</dd><dd><code>value</code> - the value of the record</dd> +<dt><span class="strong">Returns:</span></dt><dd>the new value</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/streams/kstream/JoinWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/KGroupedTable.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/KeyValueMapper.html" target="_top">Frames</a></li> +<li><a href="KeyValueMapper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/Predicate.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/Predicate.html b/0100/javadoc/org/apache/kafka/streams/kstream/Predicate.html new file mode 100644 index 0000000..fef728d --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/Predicate.html @@ -0,0 +1,215 @@ +<!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_80) on Thu May 19 00:52:05 BST 2016 --> +<title>Predicate (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="Predicate (kafka 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/streams/kstream/KTable.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/Predicate.html" target="_top">Frames</a></li> +<li><a href="Predicate.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Interface Predicate" class="title">Interface Predicate<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - key type</dd><dd><code>V</code> - value type</dd></dl> +<hr> +<br> +<pre>public interface <span class="strong">Predicate<K,V></span></pre> +<div class="block">The <a href="../../../../../org/apache/kafka/streams/kstream/Predicate.html" title="interface in org.apache.kafka.streams.kstream"><code>Predicate</code></a> interface represents a predicate (boolean-valued function) of a key-value pair.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/streams/kstream/Predicate.html#test(K,%20V)">test</a></strong>(<a href="../../../../../org/apache/kafka/streams/kstream/Predicate.html" title="type parameter in Predicate">K</a> key, + <a href="../../../../../org/apache/kafka/streams/kstream/Predicate.html" title="type parameter in Predicate">V</a> value)</code> +<div class="block">Test if the record with the given key and value satisfies the predicate.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="test(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="test(K, V)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>test</h4> +<pre>boolean test(<a href="../../../../../org/apache/kafka/streams/kstream/Predicate.html" title="type parameter in Predicate">K</a> key, + <a href="../../../../../org/apache/kafka/streams/kstream/Predicate.html" title="type parameter in Predicate">V</a> value)</pre> +<div class="block">Test if the record with the given key and value satisfies the predicate.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the record</dd><dd><code>value</code> - the value of the record</dd> +<dt><span class="strong">Returns:</span></dt><dd>return <code>true</code> if the key-value pair satisfies the predicate—<code>false</code> otherwise</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/streams/kstream/KTable.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/Predicate.html" target="_top">Frames</a></li> +<li><a href="Predicate.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/Reducer.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/Reducer.html b/0100/javadoc/org/apache/kafka/streams/kstream/Reducer.html new file mode 100644 index 0000000..3d6de20 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/Reducer.html @@ -0,0 +1,215 @@ +<!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_80) on Thu May 19 00:52:05 BST 2016 --> +<title>Reducer (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="Reducer (kafka 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/streams/kstream/Predicate.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/Reducer.html" target="_top">Frames</a></li> +<li><a href="Reducer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Interface Reducer" class="title">Interface Reducer<V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>V</code> - value type</dd></dl> +<hr> +<br> +<pre>public interface <span class="strong">Reducer<V></span></pre> +<div class="block">The <a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="interface in org.apache.kafka.streams.kstream"><code>Reducer</code></a> interface for combining two values of the same type into a new value.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/streams/kstream/Reducer.html" title="type parameter in Reducer">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html#apply(V,%20V)">apply</a></strong>(<a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="type parameter in Reducer">V</a> value1, + <a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="type parameter in Reducer">V</a> value2)</code> +<div class="block">Aggregate the two given values into a single one.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="apply(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="apply(V, V)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>apply</h4> +<pre><a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="type parameter in Reducer">V</a> apply(<a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="type parameter in Reducer">V</a> value1, + <a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="type parameter in Reducer">V</a> value2)</pre> +<div class="block">Aggregate the two given values into a single one.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value1</code> - the first value for the aggregation</dd><dd><code>value2</code> - the second value for the aggregation</dd> +<dt><span class="strong">Returns:</span></dt><dd>the aggregated value</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/streams/kstream/Predicate.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/Reducer.html" target="_top">Frames</a></li> +<li><a href="Reducer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/TimeWindows.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/TimeWindows.html b/0100/javadoc/org/apache/kafka/streams/kstream/TimeWindows.html new file mode 100644 index 0000000..973c23a --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/TimeWindows.html @@ -0,0 +1,404 @@ +<!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_80) on Thu May 19 00:52:05 BST 2016 --> +<title>TimeWindows (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="TimeWindows (kafka 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/streams/kstream/Reducer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/TimeWindows.html" target="_top">Frames</a></li> +<li><a href="TimeWindows.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Class TimeWindows" class="title">Class TimeWindows</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">org.apache.kafka.streams.kstream.Windows</a><TimeWindow></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.streams.kstream.TimeWindows</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">TimeWindows</span> +extends <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a><TimeWindow></pre> +<div class="block">The time-based window specifications used for aggregations. + <p> + The semantics of a time-based window are: Every T1 (advance) time-units, compute the aggregate total for T2 (size) time-units. + <ul> + <li> If <code>advance < size</code> a hopping windows is defined: <br /> + it discretize a stream into overlapping windows, which implies that a record maybe contained in one and or more "adjacent" windows.</li> + <li> If <code>advance == size</code> a tumbling window is defined:<br /> + it discretize a stream into non-overlapping windows, which implies that a record is only ever contained in one and only one tumbling window.</li> + </ul></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#advance">advance</a></strong></code> +<div class="block">The size of the window's advance interval, i.e.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#size">size</a></strong></code> +<div class="block">The size of the window, i.e.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.kafka.streams.kstream.Windows"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.kafka.streams.kstream.<a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a></h3> +<code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#name">name</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#segments">segments</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream">TimeWindows</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#advanceBy(long)">advanceBy</a></strong>(long interval)</code> +<div class="block">Returns a window definition with the original size, but advance ("hop") the window by the given + interval, which specifies by how much a window moves forward relative to the previous one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream">TimeWindows</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#of(java.lang.String,%20long)">of</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long size)</code> +<div class="block">Returns a window definition with the given window size, and with the advance interval being + equal to the window size.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,TimeWindow></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html#windowsFor(long)">windowsFor</a></strong>(long timestamp)</code> +<div class="block">Creates all windows that contain the provided timestamp.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.streams.kstream.Windows"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.streams.kstream.<a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a></h3> +<code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#maintainMs()">maintainMs</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#name()">name</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#segments(int)">segments</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#until(long)">until</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.ht ml?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="size"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public final long size</pre> +<div class="block">The size of the window, i.e. how long a window lasts. + The window size's effective time unit is determined by the semantics of the topology's + configured <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TimestampExtractor</code></a>.</div> +</li> +</ul> +<a name="advance"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>advance</h4> +<pre>public final long advance</pre> +<div class="block">The size of the window's advance interval, i.e. by how much a window moves forward relative + to the previous one. The interval's effective time unit is determined by the semantics of + the topology's configured <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TimestampExtractor</code></a>.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="of(java.lang.String, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream">TimeWindows</a> of(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long size)</pre> +<div class="block">Returns a window definition with the given window size, and with the advance interval being + equal to the window size. Think: [N * size, N * size + size), with N denoting the N-th + window. + + This provides the semantics of tumbling windows, which are fixed-sized, gap-less, + non-overlapping windows. Tumbling windows are a specialization of hopping windows.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of the window. Must not be null or empty.</dd><dd><code>size</code> - The size of the window, with the requirement that size > 0. + The window size's effective time unit is determined by the semantics of the + topology's configured <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TimestampExtractor</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new window definition</dd></dl> +</li> +</ul> +<a name="advanceBy(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceBy</h4> +<pre>public <a href="../../../../../org/apache/kafka/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream">TimeWindows</a> advanceBy(long interval)</pre> +<div class="block">Returns a window definition with the original size, but advance ("hop") the window by the given + interval, which specifies by how much a window moves forward relative to the previous one. + Think: [N * advanceInterval, N * advanceInterval + size), with N denoting the N-th window. + + This provides the semantics of hopping windows, which are fixed-sized, overlapping windows.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - The advance interval ("hop") of the window, with the requirement that + 0 < interval ≤ size. The interval's effective time unit is + determined by the semantics of the topology's configured + <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TimestampExtractor</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new window definition</dd></dl> +</li> +</ul> +<a name="windowsFor(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>windowsFor</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,TimeWindow> windowsFor(long timestamp)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#windowsFor(long)">Windows</a></code></strong></div> +<div class="block">Creates all windows that contain the provided timestamp.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#windowsFor(long)">windowsFor</a></code> in class <code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a><TimeWindow></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - the timestamp window should get created for</dd> +<dt><span class="strong">Returns:</span></dt><dd>a map of <code>windowStartTimestamp -> Window</code> entries</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public final boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Reducer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/TimeWindows.html" target="_top">Frames</a></li> +<li><a href="TimeWindows.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/Transformer.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/Transformer.html b/0100/javadoc/org/apache/kafka/streams/kstream/Transformer.html new file mode 100644 index 0000000..98a60e7 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/Transformer.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 (version 1.7.0_80) on Thu May 19 00:52:05 BST 2016 --> +<title>Transformer (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="Transformer (kafka 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/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/Transformer.html" target="_top">Frames</a></li> +<li><a href="Transformer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Interface Transformer" class="title">Interface Transformer<K,V,R></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - key type</dd><dd><code>V</code> - value type</dd><dd><code>R</code> - return type</dd></dl> +<hr> +<br> +<pre>public interface <span class="strong">Transformer<K,V,R></span></pre> +<div class="block">A stateful <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><code>Transformer</code></a> interface for transform a key-value pair into a new value.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#close()">close</a></strong>()</code> +<div class="block">Close this processor and clean up any resources.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#init(org.apache.kafka.streams.processor.ProcessorContext)">init</a></strong>(<a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor">ProcessorContext</a> context)</code> +<div class="block">Initialize this transformer with the given context.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#punctuate(long)">punctuate</a></strong>(long timestamp)</code> +<div class="block">Perform any periodic operations and possibly generate a key, if this processor <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the context + during <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#transform(K,%20V)">transform</a></strong>(<a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">K</a> key, + <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">V</a> value)</code> +<div class="block">Transform the record with the given key and value.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(org.apache.kafka.streams.processor.ProcessorContext)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html" title="interface in org.apache.kafka.streams.processor">ProcessorContext</a> context)</pre> +<div class="block">Initialize this transformer with the given context. The framework ensures this is called once per processor when the topology + that contains it is initialized. + <p> + If this transformer is to be <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#punctuate(long)"><code>called periodically</code></a> by the framework, then this method should + <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the provided context.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the context; may not be null</dd></dl> +</li> +</ul> +<a name="transform(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="transform(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transform</h4> +<pre><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">R</a> transform(<a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">K</a> key, + <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">V</a> value)</pre> +<div class="block">Transform the record with the given key and value.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key for the record</dd><dd><code>value</code> - the value for the record</dd> +<dt><span class="strong">Returns:</span></dt><dd>new value; if null no key-value pair will be forwarded to down stream</dd></dl> +</li> +</ul> +<a name="punctuate(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>punctuate</h4> +<pre><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="type parameter in Transformer">R</a> punctuate(long timestamp)</pre> +<div class="block">Perform any periodic operations and possibly generate a key, if this processor <a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)"><code>schedule itself</code></a> with the context + during <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - the stream time when this method is being called</dd> +<dt><span class="strong">Returns:</span></dt><dd>new value; if null it will not be forwarded to down stream</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">Close this processor and clean up any resources.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><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/streams/kstream/TimeWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/Transformer.html" target="_top">Frames</a></li> +<li><a href="Transformer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/TransformerSupplier.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/TransformerSupplier.html b/0100/javadoc/org/apache/kafka/streams/kstream/TransformerSupplier.html new file mode 100644 index 0000000..dc5ab35 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/TransformerSupplier.html @@ -0,0 +1,209 @@ +<!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_80) on Thu May 19 00:52:05 BST 2016 --> +<title>TransformerSupplier (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="TransformerSupplier (kafka 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/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/TransformerSupplier.html" target="_top">Frames</a></li> +<li><a href="TransformerSupplier.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Interface TransformerSupplier" class="title">Interface TransformerSupplier<K,V,R></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">TransformerSupplier<K,V,R></span></pre> +<div class="block">A <a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><code>TransformerSupplier</code></a> interface which can create one or more <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><code>Transformer</code></a> instances.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream">Transformer</a><<a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="type parameter in TransformerSupplier">K</a>,<a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="type parameter in TransformerSupplier">V</a>,<a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="type parameter in TransformerSupplier">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html#get()">get</a></strong>()</code> +<div class="block">Return a new <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><code>Transformer</code></a> instance.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream">Transformer</a><<a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="type parameter in TransformerSupplier">K</a>,<a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="type parameter in TransformerSupplier">V</a>,<a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="type parameter in TransformerSupplier">R</a>> get()</pre> +<div class="block">Return a new <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><code>Transformer</code></a> instance.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><code>Transformer</code></a> instance</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/streams/kstream/Transformer.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html" title="class in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/TransformerSupplier.html" target="_top">Frames</a></li> +<li><a href="TransformerSupplier.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/af5a933b/0100/javadoc/org/apache/kafka/streams/kstream/UnlimitedWindows.html ---------------------------------------------------------------------- diff --git a/0100/javadoc/org/apache/kafka/streams/kstream/UnlimitedWindows.html b/0100/javadoc/org/apache/kafka/streams/kstream/UnlimitedWindows.html new file mode 100644 index 0000000..7104d35 --- /dev/null +++ b/0100/javadoc/org/apache/kafka/streams/kstream/UnlimitedWindows.html @@ -0,0 +1,356 @@ +<!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_80) on Thu May 19 00:52:05 BST 2016 --> +<title>UnlimitedWindows (kafka 0.10.0.0 API)</title> +<meta name="date" content="2016-05-19"> +<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="UnlimitedWindows (kafka 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/streams/kstream/TransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/ValueJoiner.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/UnlimitedWindows.html" target="_top">Frames</a></li> +<li><a href="UnlimitedWindows.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.streams.kstream</div> +<h2 title="Class UnlimitedWindows" class="title">Class UnlimitedWindows</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">org.apache.kafka.streams.kstream.Windows</a><UnlimitedWindow></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.streams.kstream.UnlimitedWindows</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">UnlimitedWindows</span> +extends <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a><UnlimitedWindow></pre> +<div class="block">The unlimited window specifications.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html#start">start</a></strong></code> +<div class="block">The start timestamp of the window.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.kafka.streams.kstream.Windows"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.kafka.streams.kstream.<a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a></h3> +<code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#name">name</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#segments">segments</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html" title="class in org.apache.kafka.streams.kstream">UnlimitedWindows</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html#of(java.lang.String)">of</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Return an unlimited window starting at timestamp zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html" title="class in org.apache.kafka.streams.kstream">UnlimitedWindows</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html#startOn(long)">startOn</a></strong>(long start)</code> +<div class="block">Return a new unlimited window for the specified start timestamp.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,UnlimitedWindow></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html#windowsFor(long)">windowsFor</a></strong>(long timestamp)</code> +<div class="block">Creates all windows that contain the provided timestamp.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.streams.kstream.Windows"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.streams.kstream.<a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a></h3> +<code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#maintainMs()">maintainMs</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#name()">name</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#segments(int)">segments</a>, <a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#until(long)">until</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.ht ml?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="start"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>start</h4> +<pre>public final long start</pre> +<div class="block">The start timestamp of the window.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="of(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html" title="class in org.apache.kafka.streams.kstream">UnlimitedWindows</a> of(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Return an unlimited window starting at timestamp zero.</div> +</li> +</ul> +<a name="startOn(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startOn</h4> +<pre>public <a href="../../../../../org/apache/kafka/streams/kstream/UnlimitedWindows.html" title="class in org.apache.kafka.streams.kstream">UnlimitedWindows</a> startOn(long start)</pre> +<div class="block">Return a new unlimited window for the specified start timestamp.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - the window start time</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new unlimited window that starts at <code>start</code></dd></dl> +</li> +</ul> +<a name="windowsFor(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>windowsFor</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>,UnlimitedWindow> windowsFor(long timestamp)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#windowsFor(long)">Windows</a></code></strong></div> +<div class="block">Creates all windows that contain the provided timestamp.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html#windowsFor(long)">windowsFor</a></code> in class <code><a href="../../../../../org/apache/kafka/streams/kstream/Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a><UnlimitedWindow></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - the timestamp window should get created for</dd> +<dt><span class="strong">Returns:</span></dt><dd>a map of <code>windowStartTimestamp -> Window</code> entries</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public final boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/streams/kstream/TransformerSupplier.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/streams/kstream/ValueJoiner.html" title="interface in org.apache.kafka.streams.kstream"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/streams/kstream/UnlimitedWindows.html" target="_top">Frames</a></li> +<li><a href="UnlimitedWindows.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
