You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ya...@apache.org on 2014/12/05 19:52:35 UTC
svn commit: r1643389 [14/27] - in /incubator/samza/site: ./ archive/
community/ contribute/ img/0.8/ img/0.8/learn/ img/0.8/learn/documentation/
img/0.8/learn/documentation/comparisons/
img/0.8/learn/documentation/container/ img/0.8/learn/documentation...
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,348 @@
+<!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_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>SystemStreamMetadata.OffsetType (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<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="SystemStreamMetadata.OffsetType (samza-api 0.8.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/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamMetadata.OffsetType.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamMetadata.OffsetType.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="#enum_constant_summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
+<li>Field | </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.samza.system</div>
+<h2 title="Enum SystemStreamMetadata.OffsetType" class="title">Enum SystemStreamMetadata.OffsetType</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.Enum<<a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a>></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.SystemStreamMetadata.OffsetType</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a>></dd>
+</dl>
+<dl>
+<dt>Enclosing class:</dt>
+<dd><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public static enum <span class="strong">SystemStreamMetadata.OffsetType</span>
+extends java.lang.Enum<<a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a>></pre>
+<div class="block">OffsetType is an enum used to define which offset should be used when
+ reading from a SystemStreamPartition for the first time.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ENUM CONSTANT SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum_constant_summary">
+<!-- -->
+</a>
+<h3>Enum Constant Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
+<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Enum Constant and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#NEWEST">NEWEST</a></strong></code>
+<div class="block">Signals the offset of the newest message in a SystemStreamPartition.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#OLDEST">OLDEST</a></strong></code>
+<div class="block">Signals the offset of the oldest message in a SystemStreamPartition.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#UPCOMING">UPCOMING</a></strong></code>
+<div class="block">Signals the offset of the next message to be written into a
+ SystemStreamPartition.</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>static <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#values()">values</a></strong>()</code>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.Enum</h3>
+<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</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.Object</h3>
+<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ENUM CONSTANT DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="enum_constant_detail">
+<!-- -->
+</a>
+<h3>Enum Constant Detail</h3>
+<a name="OLDEST">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OLDEST</h4>
+<pre>public static final <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a> OLDEST</pre>
+<div class="block">Signals the offset of the oldest message in a SystemStreamPartition.</div>
+</li>
+</ul>
+<a name="NEWEST">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>NEWEST</h4>
+<pre>public static final <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a> NEWEST</pre>
+<div class="block">Signals the offset of the newest message in a SystemStreamPartition.</div>
+</li>
+</ul>
+<a name="UPCOMING">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>UPCOMING</h4>
+<pre>public static final <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a> UPCOMING</pre>
+<div class="block">Signals the offset of the next message to be written into a
+ SystemStreamPartition. If the offset of the most recent message written
+ to a SystemStreamPartition is 7, then upcoming would signal offset 8
+ (assuming the offsets were incremental).</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="values()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>values</h4>
+<pre>public static <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a>[] values()</pre>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+<pre>
+for (SystemStreamMetadata.OffsetType c : SystemStreamMetadata.OffsetType.values())
+ System.out.println(c);
+</pre></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
+</li>
+</ul>
+<a name="valueOf(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>valueOf</h4>
+<pre>public static <a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a> valueOf(java.lang.String name)</pre>
+<div class="block">Returns the enum constant of this type with the specified name.
+The string must match <i>exactly</i> an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
+<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamMetadata.OffsetType.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamMetadata.OffsetType.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="#enum_constant_summary">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#enum_constant_detail">Enum Constants</a> | </li>
+<li>Field | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,374 @@
+<!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_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<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="SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.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/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamMetadata.SystemStreamPartitionMetadata.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.samza.system</div>
+<h2 title="Class SystemStreamMetadata.SystemStreamPartitionMetadata" class="title">Class SystemStreamMetadata.SystemStreamPartitionMetadata</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.SystemStreamMetadata.SystemStreamPartitionMetadata</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Enclosing class:</dt>
+<dd><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public static class <span class="strong">SystemStreamMetadata.SystemStreamPartitionMetadata</span>
+extends java.lang.Object</pre>
+<div class="block">Provides offset information for a given SystemStreamPartition. This
+ currently only includes offset information.</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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#SystemStreamMetadata.SystemStreamPartitionMetadata(java.lang.String,%20java.lang.String,%20java.lang.String)">SystemStreamMetadata.SystemStreamPartitionMetadata</a></strong>(java.lang.String oldestOffset,
+ java.lang.String newestOffset,
+ java.lang.String upcomingOffset)</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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getNewestOffset()">getNewestOffset</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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOffset(org.apache.samza.system.SystemStreamMetadata.OffsetType)">getOffset</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a> offsetType)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOldestOffset()">getOldestOffset</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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getUpcomingOffset()">getUpcomingOffset</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.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="SystemStreamMetadata.SystemStreamPartitionMetadata(java.lang.String, java.lang.String, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>SystemStreamMetadata.SystemStreamPartitionMetadata</h4>
+<pre>public SystemStreamMetadata.SystemStreamPartitionMetadata(java.lang.String oldestOffset,
+ java.lang.String newestOffset,
+ java.lang.String upcomingOffset)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getOldestOffset()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOldestOffset</h4>
+<pre>public java.lang.String getOldestOffset()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The oldest offset that still exists in the stream for the
+ partition given. If a partition has two messages with offsets 0
+ and 1, respectively, then this method would return 0 for the
+ oldest offset. This offset is useful when one wishes to read all
+ messages in a stream from the very beginning. A null value means
+ the stream is empty.</dd></dl>
+</li>
+</ul>
+<a name="getNewestOffset()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNewestOffset</h4>
+<pre>public java.lang.String getNewestOffset()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The newest offset that exists in the stream for the partition
+ given. If a partition has two messages with offsets 0 and 1,
+ respectively, then this method would return 1 for the newest
+ offset. This offset is useful when one wishes to see if all
+ messages have been read from a stream (offset of last message
+ read == newest offset). A null value means the stream is empty.</dd></dl>
+</li>
+</ul>
+<a name="getUpcomingOffset()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getUpcomingOffset</h4>
+<pre>public java.lang.String getUpcomingOffset()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The offset that represents the next message to be written in the
+ stream for the partition given. If a partition has two messages
+ with offsets 0 and 1, respectively, then this method would return
+ 2 for the upcoming offset. This offset is useful when one wishes
+ to pick up reading at the very end of a stream. A null value
+ means the stream is empty.</dd></dl>
+</li>
+</ul>
+<a name="getOffset(org.apache.samza.system.SystemStreamMetadata.OffsetType)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOffset</h4>
+<pre>public java.lang.String getOffset(<a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a> offsetType)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsetType</code> - The type of offset to get. Either oldest, newest, or upcoming.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The corresponding offset for the offset type requested.</dd></dl>
+</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/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamMetadata.SystemStreamPartitionMetadata.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>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,354 @@
+<!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_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>SystemStreamMetadata (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<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="SystemStreamMetadata (samza-api 0.8.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/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamMetadata.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamMetadata.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested_class_summary">Nested</a> | </li>
+<li>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.samza.system</div>
+<h2 title="Class SystemStreamMetadata" class="title">Class SystemStreamMetadata</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.SystemStreamMetadata</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="strong">SystemStreamMetadata</span>
+extends java.lang.Object</pre>
+<div class="block">SystemAdmins use this class to return useful metadata about a stream's offset
+ and partition information.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested_class_summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
+<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static class </code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></strong></code>
+<div class="block">OffsetType is an enum used to define which offset should be used when
+ reading from a SystemStreamPartition for the first time.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static class </code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></strong></code>
+<div class="block">Provides offset information for a given SystemStreamPartition.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="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/samza/system/SystemStreamMetadata.html#SystemStreamMetadata(java.lang.String,%20java.util.Map)">SystemStreamMetadata</a></strong>(java.lang.String streamName,
+ java.util.Map<<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a>> partitionMetadata)</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/samza/system/SystemStreamMetadata.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#getStreamName()">getStreamName</a></strong>()</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#getSystemStreamPartitionMetadata()">getSystemStreamPartitionMetadata</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.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/samza/system/SystemStreamMetadata.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="SystemStreamMetadata(java.lang.String, java.util.Map)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>SystemStreamMetadata</h4>
+<pre>public SystemStreamMetadata(java.lang.String streamName,
+ java.util.Map<<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a>> partitionMetadata)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getStreamName()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getStreamName</h4>
+<pre>public java.lang.String getStreamName()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The stream name that's associated with the metadata contained in an
+ instance of this class.</dd></dl>
+</li>
+</ul>
+<a name="getSystemStreamPartitionMetadata()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSystemStreamPartitionMetadata</h4>
+<pre>public java.util.Map<<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a>> getSystemStreamPartitionMetadata()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>A map of SystemStreamPartitionMetadata that includes offset
+ information for each partition.</dd></dl>
+</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/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamMetadata.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamMetadata.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li><a href="#nested_class_summary">Nested</a> | </li>
+<li>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartition.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartition.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartition.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartition.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,451 @@
+<!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_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>SystemStreamPartition (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<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="SystemStreamPartition (samza-api 0.8.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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamPartition.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamPartition.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><a href="#constructor_summary">Constr</a> | </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><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.samza.system</div>
+<h2 title="Class SystemStreamPartition" class="title">Class SystemStreamPartition</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">org.apache.samza.system.SystemStream</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.SystemStreamPartition</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">SystemStreamPartition</span>
+extends <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a>
+implements java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>></pre>
+<div class="block">Aggregate object representing a both the <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> and <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza"><code>Partition</code></a>.</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>protected int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#hash">hash</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#partition">partition</a></strong></code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_org.apache.samza.system.SystemStream">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></h3>
+<code><a href="../../../../org/apache/samza/system/SystemStream.html#stream">stream</a>, <a href="../../../../org/apache/samza/system/SystemStream.html#system">system</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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/samza/system/SystemStreamPartition.html#SystemStreamPartition(java.lang.String,%20java.lang.String,%20org.apache.samza.Partition)">SystemStreamPartition</a></strong>(java.lang.String system,
+ java.lang.String stream,
+ <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition)</code>
+<div class="block">Constructs a Samza stream partition object from specified components.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(org.apache.samza.system.SystemStreamPartition)">SystemStreamPartition</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> other)</code>
+<div class="block">Constructs a Samza stream partition object based upon an existing Samza stream partition.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(org.apache.samza.system.SystemStream,%20org.apache.samza.Partition)">SystemStreamPartition</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other,
+ <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition)</code>
+<div class="block">Constructs a Samza stream partition object based upon another Samza stream and a specified partition.</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>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#compareTo(org.apache.samza.system.SystemStreamPartition)">compareTo</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> that)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#getPartition()">getPartition</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#getSystemStream()">getSystemStream</a></strong>()</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#hashCode()">hashCode</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/samza/system/SystemStreamPartition.html#toString()">toString</a></strong>()</code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.system.SystemStream">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></h3>
+<code><a href="../../../../org/apache/samza/system/SystemStream.html#getStream()">getStream</a>, <a href="../../../../org/apache/samza/system/SystemStream.html#getSystem()">getSystem</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.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">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="partition">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>partition</h4>
+<pre>protected final <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition</pre>
+</li>
+</ul>
+<a name="hash">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>hash</h4>
+<pre>protected final int hash</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="SystemStreamPartition(java.lang.String, java.lang.String, org.apache.samza.Partition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SystemStreamPartition</h4>
+<pre>public SystemStreamPartition(java.lang.String system,
+ java.lang.String stream,
+ <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition)</pre>
+<div class="block">Constructs a Samza stream partition object from specified components.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>system</code> - The name of the system of which this stream is associated with.</dd><dd><code>stream</code> - The name of the stream as specified in the stream configuration file.</dd><dd><code>partition</code> - The partition in the stream of which this object is associated with.</dd></dl>
+</li>
+</ul>
+<a name="SystemStreamPartition(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SystemStreamPartition</h4>
+<pre>public SystemStreamPartition(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> other)</pre>
+<div class="block">Constructs a Samza stream partition object based upon an existing Samza stream partition.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - Reference to an already existing Samza stream partition.</dd></dl>
+</li>
+</ul>
+<a name="SystemStreamPartition(org.apache.samza.system.SystemStream, org.apache.samza.Partition)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>SystemStreamPartition</h4>
+<pre>public SystemStreamPartition(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other,
+ <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition)</pre>
+<div class="block">Constructs a Samza stream partition object based upon another Samza stream and a specified partition.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - Reference to an already existing Samza stream.</dd><dd><code>partition</code> - Reference to an already existing Samza partition.</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="getPartition()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPartition</h4>
+<pre>public <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> getPartition()</pre>
+</li>
+</ul>
+<a name="getSystemStream()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSystemStream</h4>
+<pre>public <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> getSystemStream()</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><a href="../../../../org/apache/samza/system/SystemStream.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></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><a href="../../../../org/apache/samza/system/SystemStream.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="toString()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toString</h4>
+<pre>public java.lang.String toString()</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="../../../../org/apache/samza/system/SystemStream.html#toString()">toString</a></code> in class <code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="compareTo(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>compareTo</h4>
+<pre>public int compareTo(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> that)</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</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/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamPartition.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamPartition.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><a href="#constructor_summary">Constr</a> | </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><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>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,319 @@
+<!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_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>SystemStreamPartitionIterator (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<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="SystemStreamPartitionIterator (samza-api 0.8.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/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamPartitionIterator.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamPartitionIterator.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.samza.system</div>
+<h2 title="Class SystemStreamPartitionIterator" class="title">Class SystemStreamPartitionIterator</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.SystemStreamPartitionIterator</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">SystemStreamPartitionIterator</span>
+extends java.lang.Object
+implements java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></pre>
+<div class="block"><code>Iterator</code> that wraps a
+ <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> to iterate over the messages
+ the consumer provides for the specified
+ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</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/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer,%20org.apache.samza.system.SystemStreamPartition)">SystemStreamPartitionIterator</a></strong>(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
+ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer,%20org.apache.samza.system.SystemStreamPartition,%20int)">SystemStreamPartitionIterator</a></strong>(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
+ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ int fetchSize)</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/samza/system/SystemStreamPartitionIterator.html#hasNext()">hasNext</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#next()">next</a></strong>()</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#remove()">remove</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, 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="SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer, org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SystemStreamPartitionIterator</h4>
+<pre>public SystemStreamPartitionIterator(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
+ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre>
+</li>
+</ul>
+<a name="SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer, org.apache.samza.system.SystemStreamPartition, int)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>SystemStreamPartitionIterator</h4>
+<pre>public SystemStreamPartitionIterator(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
+ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ int fetchSize)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="hasNext()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasNext</h4>
+<pre>public boolean hasNext()</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>hasNext</code> in interface <code>java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="next()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>next</h4>
+<pre>public <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> next()</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>next</code> in interface <code>java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="remove()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>remove</h4>
+<pre>public void remove()</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>remove</code> in interface <code>java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</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/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/SystemStreamPartitionIterator.html" target="_top">Frames</a></li>
+<li><a href="SystemStreamPartitionIterator.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>