Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html?rev=1618985&r1=1618984&r2=1618985&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html Tue Aug 19 21:01:10 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 14 22:44:30 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Tue Aug 19 13:59:33 PDT 2014 --> <title>SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-14"> +<meta name="date" content="2014-08-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </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> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -61,18 +74,18 @@ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method_summary">Method</a></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><a href="#enum.constant.detail">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -108,7 +121,7 @@ </dl> <hr> <br> -<pre>public static enum <span class="strong">SystemStreamMetadata.OffsetType</span> +<pre>public static enum <span class="typeNameLabel">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> @@ -120,27 +133,27 @@ extends java.lang.Enum<<a href="../.. <li class="blockList"> <!-- =========== ENUM CONSTANT SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="enum_constant_summary"> +<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"> +<table class="memberSummary" 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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#NEWEST">NEWEST</a></span></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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#OLDEST">OLDEST</a></span></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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#UPCOMING">UPCOMING</a></span></code> <div class="block">Signals the offset of the next message to be written into a SystemStreamPartition.</div> </td> @@ -150,39 +163,39 @@ extends java.lang.Enum<<a href="../.. </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#valueOf-java.lang.String-">valueOf</a></span>(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"> +<tr id="i1" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html#values--">values</a></span>()</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"> +<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"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -198,7 +211,7 @@ the order they are declared.</div> <li class="blockList"> <!-- ============ ENUM CONSTANT DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="enum_constant_detail"> +<li class="blockList"><a name="enum.constant.detail"> <!-- --> </a> <h3>Enum Constant Detail</h3> @@ -239,11 +252,11 @@ the order they are declared.</div> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="values()"> +<a name="values--"> <!-- --> </a> <ul class="blockList"> @@ -257,10 +270,13 @@ over the constants as follows: 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> +<dl> +<dt><span class="returnLabel">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 name="valueOf-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> @@ -271,11 +287,15 @@ for (SystemStreamMetadata.OffsetType c : 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> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">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> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> </li> </ul> </li> @@ -286,9 +306,11 @@ not permitted.)</div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -303,15 +325,15 @@ not permitted.)</div> </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> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -329,18 +351,18 @@ not permitted.)</div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method_summary">Method</a></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><a href="#enum.constant.detail">Enum Constants</a> | </li> <li>Field | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html?rev=1618985&r1=1618984&r2=1618985&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html Tue Aug 19 21:01:10 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 14 22:44:30 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Tue Aug 19 13:59:33 PDT 2014 --> <title>SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-14"> +<meta name="date" content="2014-08-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </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> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -62,17 +75,17 @@ <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> +<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> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -99,7 +112,7 @@ </dl> <hr> <br> -<pre>public static class <span class="strong">SystemStreamMetadata.SystemStreamPartitionMetadata</span> +<pre>public static class <span class="typeNameLabel">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> @@ -111,66 +124,66 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> +<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"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#SystemStreamPartitionMetadata-java.lang.String-java.lang.String-java.lang.String-">SystemStreamPartitionMetadata</a></span>(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"> +<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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getNewestOffset--">getNewestOffset</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOffset-org.apache.samza.system.SystemStreamMetadata.OffsetType-">getOffset</a></span>(<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"> +<tr id="i3" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getOldestOffset--">getOldestOffset</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i4" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#getUpcomingOffset--">getUpcomingOffset</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i5" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#hashCode--">hashCode</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i6" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#toString--">toString</a></span>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -186,86 +199,99 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> +<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 name="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> +<h4>SystemStreamPartitionMetadata</h4> +<pre>public 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"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getOldestOffset()"> +<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 +<dl> +<dt><span class="returnLabel">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> + the stream is empty.</dd> +</dl> </li> </ul> -<a name="getNewestOffset()"> +<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 +<dl> +<dt><span class="returnLabel">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> + read == newest offset). A null value means the stream is empty.</dd> +</dl> </li> </ul> -<a name="getUpcomingOffset()"> +<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 +<dl> +<dt><span class="returnLabel">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> + means the stream is empty.</dd> +</dl> </li> </ul> -<a name="getOffset(org.apache.samza.system.SystemStreamMetadata.OffsetType)"> +<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> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>offsetType</code> - The type of offset to get. Either oldest, newest, or upcoming.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The corresponding offset for the offset type requested.</dd> +</dl> </li> </ul> -<a name="hashCode()"> +<a name="hashCode--"> <!-- --> </a> <ul class="blockList"> @@ -273,12 +299,12 @@ extends java.lang.Object</pre> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> -<a name="equals(java.lang.Object)"> +<a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> @@ -286,12 +312,12 @@ extends java.lang.Object</pre> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> -<a name="toString()"> +<a name="toString--"> <!-- --> </a> <ul class="blockListLast"> @@ -299,7 +325,7 @@ extends java.lang.Object</pre> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> @@ -312,9 +338,11 @@ extends java.lang.Object</pre> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -329,15 +357,15 @@ extends java.lang.Object</pre> </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> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -356,17 +384,17 @@ extends java.lang.Object</pre> <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> +<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> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html?rev=1618985&r1=1618984&r2=1618985&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html Tue Aug 19 21:01:10 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 14 22:44:30 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Tue Aug 19 13:59:33 PDT 2014 --> <title>SystemStreamMetadata (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-14"> +<meta name="date" content="2014-08-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamMetadata (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemStreamMetadata (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </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> +<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -60,19 +73,19 @@ <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested_class_summary">Nested</a> | </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> +<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> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -95,7 +108,7 @@ <li class="blockList"> <hr> <br> -<pre>public class <span class="strong">SystemStreamMetadata</span> +<pre>public class <span class="typeNameLabel">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> @@ -107,11 +120,11 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested_class_summary"> +<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"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -119,14 +132,14 @@ extends java.lang.Object</pre> </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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></span></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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></span></code> <div class="block">Provides offset information for a given SystemStreamPartition.</div> </td> </tr> @@ -135,17 +148,17 @@ extends java.lang.Object</pre> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> +<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"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#SystemStreamMetadata(java.lang.String,%20java.util.Map)">SystemStreamMetadata</a></strong>(java.lang.String streamName, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#SystemStreamMetadata-java.lang.String-java.util.Map-">SystemStreamMetadata</a></span>(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> @@ -153,39 +166,39 @@ extends java.lang.Object</pre> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#getStreamName--">getStreamName</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#getSystemStreamPartitionMetadata--">getSystemStreamPartitionMetadata</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i3" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#hashCode--">hashCode</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i4" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#toString--">toString</a></span>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -201,51 +214,57 @@ extends java.lang.Object</pre> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> +<li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="SystemStreamMetadata(java.lang.String, java.util.Map)"> +<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> + 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"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getStreamName()"> +<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> +<dl> +<dt><span class="returnLabel">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 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> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map of SystemStreamPartitionMetadata that includes offset + information for each partition.</dd> +</dl> </li> </ul> -<a name="hashCode()"> +<a name="hashCode--"> <!-- --> </a> <ul class="blockList"> @@ -253,12 +272,12 @@ extends java.lang.Object</pre> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> -<a name="equals(java.lang.Object)"> +<a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> @@ -266,12 +285,12 @@ extends java.lang.Object</pre> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> -<a name="toString()"> +<a name="toString--"> <!-- --> </a> <ul class="blockListLast"> @@ -279,7 +298,7 @@ extends java.lang.Object</pre> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> -<dt><strong>Overrides:</strong></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> @@ -292,9 +311,11 @@ extends java.lang.Object</pre> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -309,15 +330,15 @@ extends java.lang.Object</pre> </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> +<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -334,19 +355,19 @@ extends java.lang.Object</pre> <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested_class_summary">Nested</a> | </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> +<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> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamPartition.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamPartition.html?rev=1618985&r1=1618984&r2=1618985&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamPartition.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStreamPartition.html Tue Aug 19 21:01:10 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 14 22:44:30 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Tue Aug 19 13:59:33 PDT 2014 --> <title>SystemStreamPartition (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-14"> +<meta name="date" content="2014-08-19"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SystemStreamPartition (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemStreamPartition (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </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> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -61,18 +74,18 @@ <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> +<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> +<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 name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -104,7 +117,7 @@ </dl> <hr> <br> -<pre>public class <span class="strong">SystemStreamPartition</span> +<pre>public class <span class="typeNameLabel">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> @@ -116,11 +129,11 @@ implements java.lang.Comparable<<a hr <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="field_summary"> +<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"> +<table class="memberSummary" 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> @@ -128,15 +141,15 @@ implements java.lang.Comparable<<a hr </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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#hash">hash</a></span></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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#partition">partition</a></span></code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="fields_inherited_from_class_org.apache.samza.system.SystemStream"> +<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> @@ -146,29 +159,29 @@ implements java.lang.Comparable<<a hr </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> +<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"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><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, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition-java.lang.String-java.lang.String-org.apache.samza.Partition-">SystemStreamPartition</a></span>(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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition-org.apache.samza.system.SystemStreamPartition-">SystemStreamPartition</a></span>(<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, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition-org.apache.samza.system.SystemStream-org.apache.samza.Partition-">SystemStreamPartition</a></span>(<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> @@ -178,50 +191,50 @@ implements java.lang.Comparable<<a hr </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#compareTo-org.apache.samza.system.SystemStreamPartition-">compareTo</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> that)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#getPartition--">getPartition</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i3" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#getSystemStream--">getSystemStream</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i4" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#hashCode--">hashCode</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i5" 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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#toString--">toString</a></span>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.system.SystemStream"> +<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> +<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"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -237,7 +250,7 @@ implements java.lang.Comparable<<a hr <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="field_detail"> +<li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> @@ -263,24 +276,29 @@ implements java.lang.Comparable<<a hr </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> +<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 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> + 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> +<dl> +<dt><span class="paramLabel">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 name="SystemStreamPartition-org.apache.samza.system.SystemStreamPartition-"> <!-- --> </a> <ul class="blockList"> @@ -288,30 +306,37 @@ implements java.lang.Comparable<<a hr <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> +<dl> +<dt><span class="paramLabel">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 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> + <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> +<dl> +<dt><span class="paramLabel">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"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getPartition()"> +<a name="getPartition--"> <!-- --> </a> <ul class="blockList"> @@ -320,7 +345,7 @@ implements java.lang.Comparable<<a hr <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 name="getSystemStream--"> <!-- --> </a> <ul class="blockList"> @@ -329,7 +354,7 @@ implements java.lang.Comparable<<a hr <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 name="hashCode--"> <!-- --> </a> <ul class="blockList"> @@ -337,12 +362,12 @@ implements java.lang.Comparable<<a hr <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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></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 name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> @@ -350,12 +375,12 @@ implements java.lang.Comparable<<a hr <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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></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 name="toString--"> <!-- --> </a> <ul class="blockList"> @@ -363,12 +388,12 @@ implements java.lang.Comparable<<a hr <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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></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 name="compareTo-org.apache.samza.system.SystemStreamPartition-"> <!-- --> </a> <ul class="blockListLast"> @@ -376,7 +401,7 @@ implements java.lang.Comparable<<a hr <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> +<dt><span class="overrideSpecifyLabel">Specified by:</span></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> @@ -389,9 +414,11 @@ implements java.lang.Comparable<<a hr </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -406,15 +433,15 @@ implements java.lang.Comparable<<a hr </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> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system"><span class="typeNameLink">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> +<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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -432,18 +459,18 @@ implements java.lang.Comparable<<a hr <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> +<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> +<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 name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
