Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemProducer (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <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="SystemProducer (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemProducer (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStream.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/SystemProducer.html" target="_top">Frames</a></li> -<li><a href="SystemProducer.html" target="_top">No Frames</a></li> +<li><a href="SystemProducer.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"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </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>Field | </li> <li>Constr | </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 ========= --> @@ -87,7 +100,7 @@ <li class="blockList"> <hr> <br> -<pre>public interface <span class="strong">SystemProducer</span></pre> +<pre>public interface <span class="typeNameLabel">SystemProducer</span></pre> <div class="block">SystemProducers are how Samza writes messages from <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s to outside systems, such as messaging systems like Kafka, or file systems. Implementations are responsible for accepting messages and writing them to their backing systems.</div> @@ -99,45 +112,45 @@ <li class="blockList"> <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush</a></strong>(java.lang.String source)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemProducer.html#flush-java.lang.String-">flush</a></span>(java.lang.String source)</code> <div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those messages and leave no messages remaining to be sent.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#register(java.lang.String)">register</a></strong>(java.lang.String source)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemProducer.html#register-java.lang.String-">register</a></span>(java.lang.String source)</code> <div class="block">Registers this producer to send messages from a specified Samza source, such as a StreamTask.</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#send(java.lang.String,%20org.apache.samza.system.OutgoingMessageEnvelope)">send</a></strong>(java.lang.String source, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemProducer.html#send-java.lang.String-org.apache.samza.system.OutgoingMessageEnvelope-">send</a></span>(java.lang.String source, <a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</code> <div class="block">Sends a specified message envelope from a specified Samza source.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#start()">start</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemProducer.html#start--">start</a></span>()</code> <div class="block">Start the SystemProducer.</div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#stop()">stop</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemProducer.html#stop--">stop</a></span>()</code> <div class="block">Stop the SystemProducer.</div> </td> </tr> @@ -152,11 +165,11 @@ <li class="blockList"> <!-- ============ 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="start()"> +<a name="start--"> <!-- --> </a> <ul class="blockList"> @@ -166,7 +179,7 @@ <div class="block">Start the SystemProducer. After this method finishes it should be ready to accept messages received from the send method.</div> </li> </ul> -<a name="stop()"> +<a name="stop--"> <!-- --> </a> <ul class="blockList"> @@ -177,7 +190,7 @@ any remaining messages and will not receive any new calls to the send method.</div> </li> </ul> -<a name="register(java.lang.String)"> +<a name="register-java.lang.String-"> <!-- --> </a> <ul class="blockList"> @@ -185,22 +198,29 @@ <h4>register</h4> <pre>void register(java.lang.String source)</pre> <div class="block">Registers this producer to send messages from a specified Samza source, such as a StreamTask.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>source</code> - String representing the source of the message.</dd> +</dl> </li> </ul> -<a name="send(java.lang.String, org.apache.samza.system.OutgoingMessageEnvelope)"> +<a name="send-java.lang.String-org.apache.samza.system.OutgoingMessageEnvelope-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>send</h4> <pre>void send(java.lang.String source, - <a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</pre> + <a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</pre> <div class="block">Sends a specified message envelope from a specified Samza source.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd><dd><code>envelope</code> - Aggregate object representing the serialized message to send from the source.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>source</code> - String representing the source of the message.</dd> +<dd><code>envelope</code> - Aggregate object representing the serialized message to send from the source.</dd> +</dl> </li> </ul> -<a name="flush(java.lang.String)"> +<a name="flush-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> @@ -209,7 +229,10 @@ <pre>void flush(java.lang.String source)</pre> <div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those messages and leave no messages remaining to be sent.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>source</code> - String representing the source of the message.</dd> +</dl> </li> </ul> </li> @@ -220,9 +243,11 @@ </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"> @@ -237,15 +262,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStream.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/SystemProducer.html" target="_top">Frames</a></li> -<li><a href="SystemProducer.html" target="_top">No Frames</a></li> +<li><a href="SystemProducer.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"><!-- @@ -265,16 +290,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </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>Field | </li> <li>Constr | </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/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemStream (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <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="SystemStream (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemStream (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/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.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/SystemStream.html" target="_top">Frames</a></li> -<li><a href="SystemStream.html" target="_top">No Frames</a></li> +<li><a href="SystemStream.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 ========= --> @@ -99,7 +112,7 @@ </dl> <hr> <br> -<pre>public class <span class="strong">SystemStream</span> +<pre>public class <span class="typeNameLabel">SystemStream</span> extends java.lang.Object</pre> <div class="block">Streams in Samza consist of both the stream name and the system to which the stream belongs. Systems are defined through the job config and have corresponding serdes, producers and @@ -114,11 +127,11 @@ extends java.lang.Object</pre> <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> @@ -126,34 +139,34 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#stream">stream</a></strong></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.html#stream">stream</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#system">system</a></strong></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.html#system">system</a></span></code> </td> </tr> </table> </li> </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/SystemStream.html#SystemStream(java.lang.String,%20java.lang.String)">SystemStream</a></strong>(java.lang.String system, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.html#SystemStream-java.lang.String-java.lang.String-">SystemStream</a></span>(java.lang.String system, java.lang.String stream)</code> <div class="block">Constructs a Samza stream object from specified components.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#SystemStream(org.apache.samza.system.SystemStream)">SystemStream</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.html#SystemStream-org.apache.samza.system.SystemStream-">SystemStream</a></span>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other)</code> <div class="block">Constructs a Samza stream object based upon an existing Samza stream.</div> </td> </tr> @@ -162,39 +175,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/SystemStream.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/SystemStream.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/SystemStream.html#getStream()">getStream</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.html#getStream--">getStream</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/SystemStream.html#getSystem()">getSystem</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.html#getSystem--">getSystem</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/SystemStream.html#hashCode()">hashCode</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.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/SystemStream.html#toString()">toString</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/system/SystemStream.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> @@ -210,7 +223,7 @@ extends java.lang.Object</pre> <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> @@ -236,23 +249,27 @@ extends java.lang.Object</pre> </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="SystemStream(java.lang.String, java.lang.String)"> +<a name="SystemStream-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>SystemStream</h4> <pre>public SystemStream(java.lang.String system, - java.lang.String stream)</pre> + java.lang.String stream)</pre> <div class="block">Constructs a Samza stream 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></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> +</dl> </li> </ul> -<a name="SystemStream(org.apache.samza.system.SystemStream)"> +<a name="SystemStream-org.apache.samza.system.SystemStream-"> <!-- --> </a> <ul class="blockListLast"> @@ -260,18 +277,21 @@ extends java.lang.Object</pre> <h4>SystemStream</h4> <pre>public SystemStream(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other)</pre> <div class="block">Constructs a Samza stream object based upon an existing Samza stream.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - Reference to an already existing Samza stream.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>other</code> - Reference to an already existing Samza stream.</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="getSystem()"> +<a name="getSystem--"> <!-- --> </a> <ul class="blockList"> @@ -280,7 +300,7 @@ extends java.lang.Object</pre> <pre>public java.lang.String getSystem()</pre> </li> </ul> -<a name="getStream()"> +<a name="getStream--"> <!-- --> </a> <ul class="blockList"> @@ -289,7 +309,7 @@ extends java.lang.Object</pre> <pre>public java.lang.String getStream()</pre> </li> </ul> -<a name="hashCode()"> +<a name="hashCode--"> <!-- --> </a> <ul class="blockList"> @@ -297,12 +317,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"> @@ -310,12 +330,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"> @@ -323,7 +343,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> @@ -336,9 +356,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"> @@ -353,15 +375,15 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.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/SystemStream.html" target="_top">Frames</a></li> -<li><a href="SystemStream.html" target="_top">No Frames</a></li> +<li><a href="SystemStream.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"><!-- @@ -379,18 +401,18 @@ extends java.lang.Object</pre> <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 ======= --> Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemStreamMetadata.OffsetType (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <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/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html?rev=1614174&r1=1614173&r2=1614174&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html (original) +++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html Mon Jul 28 20:57:48 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 23 22:03:29 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_11) on Mon Jul 28 13:54:07 PDT 2014 --> <title>SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-07-23"> +<meta name="date" content="2014-07-28"> <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 ======= -->
