Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-tree.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-tree.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-tree.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/task/package-tree.html Fri Sep 19 16:33:36 2014 @@ -2,20 +2,15 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:32 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>org.apache.samza.task Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.task Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.task Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; } //--> </script> @@ -23,11 +18,9 @@ <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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -47,10 +40,10 @@ </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.html" target="_top">No Frames</a></li> +<li><a href="package-tree.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"><!-- @@ -64,13 +57,13 @@ //--> </script> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <div class="header"> <h1 class="title">Hierarchy For Package org.apache.samza.task</h1> -<span class="packageHierarchyLabel">Package Hierarchies:</span> +<span class="strong">Package Hierarchies:</span> <ul class="horizontal"> <li><a href="../../../../overview-tree.html">All Packages</a></li> </ul> @@ -78,15 +71,15 @@ <div class="contentContainer"> <h2 title="Interface Hierarchy">Interface Hierarchy</h2> <ul> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">ClosableTask</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">InitableTask</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="typeNameLink">MessageCollector</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">StreamTask</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="typeNameLink">TaskContext</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="typeNameLink">TaskCoordinator</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="typeNameLink">TaskLifecycleListener</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="typeNameLink">TaskLifecycleListenerFactory</span></a></li> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="typeNameLink">WindowableTask</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="strong">ClosableTask</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">InitableTask</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">MessageCollector</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">StreamTask</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">TaskContext</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">TaskCoordinator</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">TaskLifecycleListener</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">TaskLifecycleListenerFactory</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="strong">WindowableTask</span></a></li> </ul> <h2 title="Enum Hierarchy">Enum Hierarchy</h2> <ul> @@ -94,7 +87,7 @@ <ul> <li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) <ul> -<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="typeNameLink">TaskCoordinator.RequestScope</span></a></li> +<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">TaskCoordinator.RequestScope</span></a></li> </ul> </li> </ul> @@ -102,11 +95,9 @@ </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -126,10 +117,10 @@ </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/task/package-tree.html" target="_top">Frames</a></li> -<li><a href="package-tree.html" target="_top">No Frames</a></li> +<li><a href="package-tree.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"><!-- @@ -143,7 +134,7 @@ //--> </script> </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/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.8.0-SNAPSHOT API)"; } //--> -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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" target="_top">Frames</a></li> -<li><a href="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" target="_top">No Frames</a></li> +<li><a href="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.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"><!-- @@ -75,17 +62,17 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -112,7 +99,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <span class="typeNameLabel">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</span> +<pre>public class <span class="strong">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</span> extends java.lang.Object</pre> </li> </ul> @@ -122,58 +109,58 @@ 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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#BlockingEnvelopeMapMetrics-java.lang.String-org.apache.samza.metrics.MetricsRegistry-">BlockingEnvelopeMapMetrics</a></span>(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String,%20org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></strong>(java.lang.String group, + <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</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="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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingPoll-org.apache.samza.system.SystemStreamPartition-">incBlockingPoll</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingPoll(org.apache.samza.system.SystemStreamPartition)">incBlockingPoll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingTimeoutPoll-org.apache.samza.system.SystemStreamPartition-">incBlockingTimeoutPoll</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingTimeoutPoll(org.apache.samza.system.SystemStreamPartition)">incBlockingTimeoutPoll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incPoll--">incPoll</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incPoll()">incPoll</a></strong>()</code> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#initMetrics-org.apache.samza.system.SystemStreamPartition-">initMetrics</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#initMetrics(org.apache.samza.system.SystemStreamPartition)">initMetrics</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#setNoMoreMessages-org.apache.samza.system.SystemStreamPartition-boolean-">setNoMoreMessages</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#setNoMoreMessages(org.apache.samza.system.SystemStreamPartition,%20boolean)">setNoMoreMessages</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, boolean noMoreMessages)</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> @@ -189,29 +176,29 @@ 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="BlockingEnvelopeMapMetrics-java.lang.String-org.apache.samza.metrics.MetricsRegistry-"> +<a name="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String, org.apache.samza.metrics.MetricsRegistry)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>BlockingEnvelopeMapMetrics</h4> -<pre>public BlockingEnvelopeMapMetrics(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</pre> +<h4>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</h4> +<pre>public BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String group, + <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</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="initMetrics-org.apache.samza.system.SystemStreamPartition-"> +<a name="initMetrics(org.apache.samza.system.SystemStreamPartition)"> <!-- --> </a> <ul class="blockList"> @@ -220,17 +207,17 @@ extends java.lang.Object</pre> <pre>public void initMetrics(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre> </li> </ul> -<a name="setNoMoreMessages-org.apache.samza.system.SystemStreamPartition-boolean-"> +<a name="setNoMoreMessages(org.apache.samza.system.SystemStreamPartition, boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setNoMoreMessages</h4> <pre>public void setNoMoreMessages(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - boolean noMoreMessages)</pre> + boolean noMoreMessages)</pre> </li> </ul> -<a name="incBlockingPoll-org.apache.samza.system.SystemStreamPartition-"> +<a name="incBlockingPoll(org.apache.samza.system.SystemStreamPartition)"> <!-- --> </a> <ul class="blockList"> @@ -239,7 +226,7 @@ extends java.lang.Object</pre> <pre>public void incBlockingPoll(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre> </li> </ul> -<a name="incBlockingTimeoutPoll-org.apache.samza.system.SystemStreamPartition-"> +<a name="incBlockingTimeoutPoll(org.apache.samza.system.SystemStreamPartition)"> <!-- --> </a> <ul class="blockList"> @@ -248,7 +235,7 @@ extends java.lang.Object</pre> <pre>public void incBlockingTimeoutPoll(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre> </li> </ul> -<a name="incPoll--"> +<a name="incPoll()"> <!-- --> </a> <ul class="blockListLast"> @@ -265,11 +252,9 @@ 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> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -284,15 +269,15 @@ extends java.lang.Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" target="_top">Frames</a></li> -<li><a href="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" target="_top">No Frames</a></li> +<li><a href="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.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"><!-- @@ -311,17 +296,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/util/BlockingEnvelopeMap.BufferGauge.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>BlockingEnvelopeMap.BufferGauge (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BlockingEnvelopeMap.BufferGauge (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BlockingEnvelopeMap.BufferGauge (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" target="_top">Frames</a></li> -<li><a href="BlockingEnvelopeMap.BufferGauge.html" target="_top">No Frames</a></li> +<li><a href="BlockingEnvelopeMap.BufferGauge.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"><!-- @@ -75,17 +62,17 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -121,7 +108,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <span class="typeNameLabel">BlockingEnvelopeMap.BufferGauge</span> +<pre>public class <span class="strong">BlockingEnvelopeMap.BufferGauge</span> extends <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><java.lang.Integer></pre> </li> </ul> @@ -131,48 +118,48 @@ extends <a href="../../../../org/apache/ <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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#BufferGauge-org.apache.samza.system.SystemStreamPartition-java.lang.String-">BufferGauge</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String name)</code> </td> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">BlockingEnvelopeMap.BufferGauge</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, + java.lang.String name)</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="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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.Integer</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#getValue--">getValue</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#getValue()">getValue</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.metrics.Gauge"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.metrics.Gauge"> <!-- --> </a> <h3>Methods inherited from class org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></h3> -<code><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet-T-T-">compareAndSet</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#getName--">getName</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#set-T-">set</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#toString--">toString</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#visit-org.apache.samza.metrics.MetricsVisitor-">visit</a></code></li> +<code><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#getName()">getName</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#toString()">toString</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</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> @@ -188,29 +175,29 @@ extends <a href="../../../../org/apache/ <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="BufferGauge-org.apache.samza.system.SystemStreamPartition-java.lang.String-"> +<a name="BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition, java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>BufferGauge</h4> -<pre>public BufferGauge(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String name)</pre> +<h4>BlockingEnvelopeMap.BufferGauge</h4> +<pre>public BlockingEnvelopeMap.BufferGauge(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, + java.lang.String name)</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="getValue--"> +<a name="getValue()"> <!-- --> </a> <ul class="blockListLast"> @@ -218,8 +205,8 @@ extends <a href="../../../../org/apache/ <h4>getValue</h4> <pre>public java.lang.Integer getValue()</pre> <dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/Gauge.html#getValue--">getValue</a></code> in class <code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><java.lang.Integer></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/Gauge.html#getValue()">getValue</a></code> in class <code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><java.lang.Integer></code></dd> </dl> </li> </ul> @@ -231,11 +218,9 @@ extends <a href="../../../../org/apache/ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -250,15 +235,15 @@ extends <a href="../../../../org/apache/ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" target="_top">Frames</a></li> -<li><a href="BlockingEnvelopeMap.BufferGauge.html" target="_top">No Frames</a></li> +<li><a href="BlockingEnvelopeMap.BufferGauge.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"><!-- @@ -277,17 +262,17 @@ extends <a href="../../../../org/apache/ <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/util/BlockingEnvelopeMap.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html?rev=1626269&r1=1626268&r2=1626269&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html Fri Sep 19 16:33:36 2014 @@ -2,38 +2,25 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_20) on Thu Sep 11 14:53:31 PDT 2014 --> +<!-- Generated by javadoc (version 1.7.0_65) on Fri Sep 19 09:32:34 PDT 2014 --> <title>BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-11"> +<meta name="date" content="2014-09-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"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)"; } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -48,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.html" target="_top">Frames</a></li> -<li><a href="BlockingEnvelopeMap.html" target="_top">No Frames</a></li> +<li><a href="BlockingEnvelopeMap.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"><!-- @@ -73,19 +60,19 @@ var activeTableTab = "activeTableTab"; <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 ========= --> @@ -112,7 +99,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public abstract class <span class="typeNameLabel">BlockingEnvelopeMap</span> +<pre>public abstract class <span class="strong">BlockingEnvelopeMap</span> extends java.lang.Object implements <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></pre> <div class="block"><p> @@ -126,13 +113,16 @@ implements <a href="../../../../org/apac <p> SystemConsumers that implement BlockingEnvelopeMap need to add messages using - add (or addAll), and update noMoreMessage using setIsAtHead. The - noMoreMessage variable is used to determine whether a SystemStreamPartition - is "caught up" (has read all possible messages from the underlying system). - For example, with a Kafka system, noMoreMessages would be set to true when - the last message offset returned is equal to the offset high watermark for a - given topic/partition. - </p></div> + <a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.system.IncomingMessageEnvelope)"><code>put</code></a> + (or <a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition,%20java.util.List)"><code>putAll</code></a>), + and update noMoreMessage using setIsAtHead. The noMoreMessage variable is used + to determine whether a SystemStreamPartition is "caught up" (has read all + possible messages from the underlying system). For example, with a Kafka + system, noMoreMessages would be set to true when the last message offset + returned is equal to the offset high watermark for a given topic/partition. + </p> + The BlockingEnvelopeMap is backed by a concurrent map, which allows concurrent + put or putAll calls to be thread safe without external synchronization.</div> </li> </ul> </div> @@ -141,11 +131,11 @@ implements <a href="../../../../org/apac <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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -153,23 +143,23 @@ implements <a href="../../../../org/apac </tr> <tr class="altColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></span></code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></span></code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></strong></code> </td> </tr> </table> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.summary"> +<li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.org.apache.samza.system.SystemConsumer"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.samza.system.SystemConsumer"> <!-- --> </a> <h3>Fields inherited from interface org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></h3> @@ -179,30 +169,30 @@ implements <a href="../../../../org/apac </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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap--">BlockingEnvelopeMap</a></span>()</code> </td> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap()">BlockingEnvelopeMap</a></strong>()</code> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap-org.apache.samza.util.Clock-">BlockingEnvelopeMap</a></span>(<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap-org.apache.samza.metrics.MetricsRegistry-">BlockingEnvelopeMap</a></span>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap-org.apache.samza.metrics.MetricsRegistry-org.apache.samza.util.Clock-">BlockingEnvelopeMap</a></span>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry, +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry, <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap-org.apache.samza.metrics.MetricsRegistry-org.apache.samza.util.Clock-java.lang.String-">BlockingEnvelopeMap</a></span>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry, +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock,%20java.lang.String)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry, <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock, java.lang.String metricsGroupName)</code> </td> </tr> @@ -211,72 +201,78 @@ implements <a href="../../../../org/apac </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="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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#getNumMessagesInQueue-org.apache.samza.system.SystemStreamPartition-">getNumMessagesInQueue</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#getNumMessagesInQueue(org.apache.samza.system.SystemStreamPartition)">getNumMessagesInQueue</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> </tr> -<tr id="i1" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#isAtHead-org.apache.samza.system.SystemStreamPartition-">isAtHead</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#isAtHead(org.apache.samza.system.SystemStreamPartition)">isAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>protected java.util.concurrent.BlockingQueue<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue--">newBlockingQueue</a></span>()</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue()">newBlockingQueue</a></strong>()</code> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#poll-java.util.Set-long-">poll</a></span>(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#poll(java.util.Set,%20long)">poll</a></strong>(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, long timeout)</code> <div class="block">Poll the SystemConsumer to get any available messages from the underlying system.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put-org.apache.samza.system.SystemStreamPartition-org.apache.samza.system.IncomingMessageEnvelope-">put</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.system.IncomingMessageEnvelope)">put</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, + <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code> +<div class="block">Place a new <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a> on the + queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div> +</td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll-org.apache.samza.system.SystemStreamPartition-java.util.List-">putAll</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition,%20java.util.List)">putAll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, + java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> +<div class="block">Place a collection of <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a> + on the queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div> +</td> </tr> -<tr id="i6" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">register</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, java.lang.String offset)</code> <div class="block">Register a SystemStreamPartition to this SystemConsumer.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected java.lang.Boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#setIsAtHead-org.apache.samza.system.SystemStreamPartition-boolean-">setIsAtHead</a></span>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#setIsAtHead(org.apache.samza.system.SystemStreamPartition,%20boolean)">setIsAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, boolean isAtHead)</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> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.system.SystemConsumer"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.system.SystemConsumer"> <!-- --> </a> <h3>Methods inherited from interface org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></h3> -<code><a href="../../../../org/apache/samza/system/SystemConsumer.html#start--">start</a>, <a href="../../../../org/apache/samza/system/SystemConsumer.html#stop--">stop</a></code></li> +<code><a href="../../../../org/apache/samza/system/SystemConsumer.html#start()">start</a>, <a href="../../../../org/apache/samza/system/SystemConsumer.html#stop()">stop</a></code></li> </ul> </li> </ul> @@ -288,11 +284,11 @@ implements <a href="../../../../org/apac <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="BlockingEnvelopeMap--"> +<a name="BlockingEnvelopeMap()"> <!-- --> </a> <ul class="blockList"> @@ -301,7 +297,7 @@ implements <a href="../../../../org/apac <pre>public BlockingEnvelopeMap()</pre> </li> </ul> -<a name="BlockingEnvelopeMap-org.apache.samza.util.Clock-"> +<a name="BlockingEnvelopeMap(org.apache.samza.util.Clock)"> <!-- --> </a> <ul class="blockList"> @@ -310,7 +306,7 @@ implements <a href="../../../../org/apac <pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre> </li> </ul> -<a name="BlockingEnvelopeMap-org.apache.samza.metrics.MetricsRegistry-"> +<a name="BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)"> <!-- --> </a> <ul class="blockList"> @@ -319,62 +315,58 @@ implements <a href="../../../../org/apac <pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</pre> </li> </ul> -<a name="BlockingEnvelopeMap-org.apache.samza.metrics.MetricsRegistry-org.apache.samza.util.Clock-"> +<a name="BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>BlockingEnvelopeMap</h4> <pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry, - <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre> + <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre> </li> </ul> -<a name="BlockingEnvelopeMap-org.apache.samza.metrics.MetricsRegistry-org.apache.samza.util.Clock-java.lang.String-"> +<a name="BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock, java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>BlockingEnvelopeMap</h4> <pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry, - <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock, - java.lang.String metricsGroupName)</pre> + <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock, + java.lang.String metricsGroupName)</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="register-org.apache.samza.system.SystemStreamPartition-java.lang.String-"> +<a name="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre>public void register(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.lang.String offset)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">SystemConsumer</a></code></span></div> + java.lang.String offset)</pre> <div class="block">Register a SystemStreamPartition to this SystemConsumer. The SystemConsumer should try and read messages from all SystemStreamPartitions that are registered to it. SystemStreamPartitions should only be registered before start is called.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register-org.apache.samza.system.SystemStreamPartition-java.lang.String-">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>systemStreamPartition</code> - The SystemStreamPartition object representing the Samza - SystemStreamPartition to receive messages from.</dd> -<dd><code>offset</code> - String representing the offset of the point in the stream to start +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - The SystemStreamPartition object representing the Samza + SystemStreamPartition to receive messages from.</dd><dd><code>offset</code> - String representing the offset of the point in the stream to start reading messages from. This is an inclusive parameter; if "7" were specified, the first message for the system/stream/partition to be - consumed and returned would be a message whose offset is "7".</dd> -</dl> + consumed and returned would be a message whose offset is "7".</dd></dl> </li> </ul> -<a name="newBlockingQueue--"> +<a name="newBlockingQueue()"> <!-- --> </a> <ul class="blockList"> @@ -383,16 +375,15 @@ implements <a href="../../../../org/apac <pre>protected java.util.concurrent.BlockingQueue<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> newBlockingQueue()</pre> </li> </ul> -<a name="poll-java.util.Set-long-"> +<a name="poll(java.util.Set, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>poll</h4> <pre>public java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>>> poll(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, - long timeout) + long timeout) throws java.lang.InterruptedException</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll-java.util.Set-long-">SystemConsumer</a></code></span></div> <div class="block">Poll the SystemConsumer to get any available messages from the underlying system. @@ -404,16 +395,14 @@ implements <a href="../../../../org/apac be processed while blocking is occurring. </p></div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll-java.util.Set-long-">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>systemStreamPartitions</code> - A set of SystemStreamPartition to poll for new messages. If +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Set,%20long)">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartitions</code> - A set of SystemStreamPartition to poll for new messages. If SystemConsumer has messages available for other registered SystemStreamPartitions, but they are not in the systemStreamPartitions set in a given poll invocation, they can't be returned. It is illegal to pass in SystemStreamPartitions that - have not been registered with the SystemConsumer first.</dd> -<dd><code>timeout</code> - If timeout < 0, poll will block unless all SystemStreamPartition + have not been registered with the SystemConsumer first.</dd><dd><code>timeout</code> - If timeout < 0, poll will block unless all SystemStreamPartition are at "head" (the underlying system has been checked, and returned an empty set). If at head, an empty map is returned. If timeout >= 0, poll will return any messages that are currently @@ -422,51 +411,55 @@ implements <a href="../../../../org/apac milliseconds for messages from any SystemStreamPartition to become available. It will return an empty map if the timeout is hit, and no new messages are available.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A map from SystemStreamPartitions to any available +<dt><span class="strong">Returns:</span></dt><dd>A map from SystemStreamPartitions to any available IncomingMessageEnvelopes for the SystemStreamPartitions. If no messages are available for a SystemStreamPartition that was supplied in the polling set, the map will not contain a key for the SystemStreamPartition. Will return an empty map, not null, if no new messages are available for any SystemStreamPartitions in the input set.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> +<dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code> - Thrown when a blocking poll has been interrupted by another - thread.</dd> -</dl> + thread.</dd></dl> </li> </ul> -<a name="put-org.apache.samza.system.SystemStreamPartition-org.apache.samza.system.IncomingMessageEnvelope-"> +<a name="put(org.apache.samza.system.SystemStreamPartition, org.apache.samza.system.IncomingMessageEnvelope)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>put</h4> <pre>protected void put(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope) + <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope) throws java.lang.InterruptedException</pre> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.InterruptedException</code></dd> -</dl> +<div class="block">Place a new <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a> on the + queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - SystemStreamPartition that owns the envelope</dd><dd><code>envelope</code> - Message for specified SystemStreamPartition</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - from underlying concurrent collection</dd></dl> </li> </ul> -<a name="putAll-org.apache.samza.system.SystemStreamPartition-java.util.List-"> +<a name="putAll(org.apache.samza.system.SystemStreamPartition, java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>putAll</h4> <pre>protected void putAll(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes) + java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes) throws java.lang.InterruptedException</pre> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.InterruptedException</code></dd> -</dl> +<div class="block">Place a collection of <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a> + on the queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>. + <p> + Insertion of all the messages into the queue is not guaranteed to be done + atomically. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - SystemStreamPartition that owns the envelope</dd><dd><code>envelopes</code> - Messages for specified SystemStreamPartition</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - from underlying concurrent collection</dd></dl> </li> </ul> -<a name="getNumMessagesInQueue-org.apache.samza.system.SystemStreamPartition-"> +<a name="getNumMessagesInQueue(org.apache.samza.system.SystemStreamPartition)"> <!-- --> </a> <ul class="blockList"> @@ -475,17 +468,17 @@ implements <a href="../../../../org/apac <pre>public int getNumMessagesInQueue(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre> </li> </ul> -<a name="setIsAtHead-org.apache.samza.system.SystemStreamPartition-boolean-"> +<a name="setIsAtHead(org.apache.samza.system.SystemStreamPartition, boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setIsAtHead</h4> <pre>protected java.lang.Boolean setIsAtHead(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, - boolean isAtHead)</pre> + boolean isAtHead)</pre> </li> </ul> -<a name="isAtHead-org.apache.samza.system.SystemStreamPartition-"> +<a name="isAtHead(org.apache.samza.system.SystemStreamPartition)"> <!-- --> </a> <ul class="blockListLast"> @@ -502,11 +495,9 @@ implements <a href="../../../../org/apac </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<div class="bottomNav"><a name="navbar_bottom"> <!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -521,15 +512,15 @@ implements <a href="../../../../org/apac </div> <div class="subNav"> <ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> +<li>Prev Class</li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.html" target="_top">Frames</a></li> -<li><a href="BlockingEnvelopeMap.html" target="_top">No Frames</a></li> +<li><a href="BlockingEnvelopeMap.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"><!-- @@ -546,19 +537,19 @@ implements <a href="../../../../org/apac <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 ======= -->
