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=1637130&r1=1637129&r2=1637130&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 Thu Nov 6 15:03:11 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Wed Sep 24 10:06:33 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_05) on Tue Nov 04 10:22:15 GMT 2014 --> <title>BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-24"> +<meta name="date" content="2014-11-04"> <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="BlockingEnvelopeMap (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BlockingEnvelopeMap (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,"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><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>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> +<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> </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"><!-- @@ -60,19 +73,19 @@ <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -99,7 +112,7 @@ </dl> <hr> <br> -<pre>public abstract class <span class="strong">BlockingEnvelopeMap</span> +<pre>public abstract class <span class="typeNameLabel">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> @@ -113,8 +126,8 @@ implements <a href="../../../../org/apac <p> SystemConsumers that implement BlockingEnvelopeMap need to add messages using - <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>), + <a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put-org.apache.samza.system.SystemStreamPartition-org.apache.samza.system.IncomingMessageEnvelope-"><code>put</code></a> + (or <a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll-org.apache.samza.system.SystemStreamPartition-java.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 @@ -131,11 +144,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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> @@ -143,23 +156,23 @@ implements <a href="../../../../org/apac </tr> <tr class="altColor"> <td class="colFirst"><code>class </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> +<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> </tr> <tr class="rowColor"> <td class="colFirst"><code>class </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> +<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> </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> @@ -169,30 +182,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="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/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap()">BlockingEnvelopeMap</a></strong>()</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap--">BlockingEnvelopeMap</a></span>()</code> </td> </tr> <tr class="rowColor"> -<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> +<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> </tr> <tr class="altColor"> -<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> +<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> </tr> <tr class="rowColor"> -<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, +<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, <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><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, +<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, <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> @@ -201,78 +214,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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> -<tr class="altColor"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/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> +<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> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>protected boolean</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> +<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> </tr> -<tr class="altColor"> +<tr id="i2" 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><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue()">newBlockingQueue</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue--">newBlockingQueue</a></span>()</code> </td> </tr> -<tr class="rowColor"> +<tr id="i3" 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><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, +<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, long timeout)</code> <div class="block">Poll the SystemConsumer to get any available messages from the underlying system.</div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>protected void</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, +<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> <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 class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>protected void</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, +<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> <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 class="altColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> -<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, +<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, java.lang.String offset)</code> <div class="block">Register a SystemStreamPartition to this SystemConsumer.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>protected java.lang.Boolean</code></td> -<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, +<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, 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> @@ -284,11 +297,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"> @@ -297,7 +310,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"> @@ -306,7 +319,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"> @@ -315,58 +328,61 @@ 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> + 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><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 +<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 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"> @@ -375,14 +391,14 @@ 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">Poll the SystemConsumer to get any available messages from the underlying system. @@ -395,14 +411,16 @@ implements <a href="../../../../org/apac be processed while blocking is occurring. </p></div> <dl> -<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 +<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 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 @@ -411,42 +429,48 @@ 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="strong">Returns:</span></dt><dd>A map from SystemStreamPartitions to any available +<dt><span class="returnLabel">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="strong">Throws:</span></dt> +<dt><span class="throwsLabel">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> <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> +<dl> +<dt><span class="paramLabel">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="throwsLabel">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> <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>. @@ -454,12 +478,16 @@ implements <a href="../../../../org/apac 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> +<dl> +<dt><span class="paramLabel">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="throwsLabel">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"> @@ -468,17 +496,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"> @@ -495,9 +523,11 @@ 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><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"> @@ -512,15 +542,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="strong">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="typeNameLink">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"><!-- @@ -537,19 +567,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 ======= -->
Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/Clock.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/Clock.html?rev=1637130&r1=1637129&r2=1637130&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/Clock.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/Clock.html Thu Nov 6 15:03:11 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Wed Sep 24 10:06:33 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_05) on Tue Nov 04 10:22:15 GMT 2014 --> <title>Clock (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-24"> +<meta name="date" content="2014-11-04"> <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="Clock (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Clock (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":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/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/Clock.html" target="_top">Frames</a></li> -<li><a href="Clock.html" target="_top">No Frames</a></li> +<li><a href="Clock.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">Clock</span></pre> +<pre>public interface <span class="typeNameLabel">Clock</span></pre> <div class="block">Mockable interface for tracking time.</div> </li> </ul> @@ -97,19 +110,19 @@ <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>long</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/Clock.html#currentTimeMillis()">currentTimeMillis</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/Clock.html#currentTimeMillis--">currentTimeMillis</a></span>()</code> </td> </tr> </table> </li> @@ -122,11 +135,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="currentTimeMillis()"> +<a name="currentTimeMillis--"> <!-- --> </a> <ul class="blockListLast"> @@ -143,9 +156,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"> @@ -160,15 +175,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/Clock.html" target="_top">Frames</a></li> -<li><a href="Clock.html" target="_top">No Frames</a></li> +<li><a href="Clock.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"><!-- @@ -188,16 +203,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/latest/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html?rev=1637130&r1=1637129&r2=1637130&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html Thu Nov 6 15:03:11 2014 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_65) on Wed Sep 24 10:06:33 PDT 2014 --> +<!-- Generated by javadoc (1.8.0_05) on Tue Nov 04 10:22:15 GMT 2014 --> <title>NoOpMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-09-24"> +<meta name="date" content="2014-11-04"> <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="NoOpMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="NoOpMetricsRegistry (samza-api 0.8.0-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/NoOpMetricsRegistry.html" target="_top">Frames</a></li> -<li><a href="NoOpMetricsRegistry.html" target="_top">No Frames</a></li> +<li><a href="NoOpMetricsRegistry.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 class <span class="strong">NoOpMetricsRegistry</span> +<pre>public class <span class="typeNameLabel">NoOpMetricsRegistry</span> extends java.lang.Object implements <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></pre> <div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be @@ -112,79 +125,79 @@ implements <a href="../../../../org/apac <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/util/NoOpMetricsRegistry.html#NoOpMetricsRegistry()">NoOpMetricsRegistry</a></strong>()</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#NoOpMetricsRegistry--">NoOpMetricsRegistry</a></span>()</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><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter-java.lang.String-org.apache.samza.metrics.Counter-">newCounter</a></span>(java.lang.String group, <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter-java.lang.String-java.lang.String-">newCounter</a></span>(java.lang.String group, java.lang.String name)</code> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge-java.lang.String-org.apache.samza.metrics.Gauge-">newGauge</a></span>(java.lang.String group, <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code> <div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge-java.lang.String-java.lang.String-T-">newGauge</a></span>(java.lang.String group, java.lang.String name, T value)</code> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">newTimer</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newTimer-java.lang.String-java.lang.String-">newTimer</a></span>(java.lang.String group, java.lang.String name)</code> <div class="block">Create and Register a new <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> </td> </tr> -<tr class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">newTimer</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newTimer-java.lang.String-org.apache.samza.metrics.Timer-">newTimer</a></span>(java.lang.String group, <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</code> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> </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> @@ -200,11 +213,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="NoOpMetricsRegistry()"> +<a name="NoOpMetricsRegistry--"> <!-- --> </a> <ul class="blockListLast"> @@ -217,113 +230,142 @@ implements <a href="../../../../org/apac </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="newCounter(java.lang.String, java.lang.String)"> +<a name="newCounter-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newCounter</h4> <pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group, - java.lang.String name)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">MetricsRegistry</a></code></strong></div> + java.lang.String name)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter-java.lang.String-java.lang.String-">MetricsRegistry</a></code></span></div> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> <dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>name</code> - Name of to-be-created Counter</dd> -<dt><span class="strong">Returns:</span></dt><dd>New Counter instance</dd></dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter-java.lang.String-java.lang.String-">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Counter</dd> +<dd><code>name</code> - Name of to-be-created Counter</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>New Counter instance</dd> +</dl> </li> </ul> -<a name="newCounter(java.lang.String, org.apache.samza.metrics.Counter)"> +<a name="newCounter-java.lang.String-org.apache.samza.metrics.Counter-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newCounter</h4> <pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">MetricsRegistry</a></code></strong></div> + <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter-java.lang.String-org.apache.samza.metrics.Counter-">MetricsRegistry</a></code></span></div> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> <dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>counter</code> - Existing Counter to register</dd> -<dt><span class="strong">Returns:</span></dt><dd>Counter that was registered</dd></dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter-java.lang.String-org.apache.samza.metrics.Counter-">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Counter</dd> +<dd><code>counter</code> - Existing Counter to register</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Counter that was registered</dd> +</dl> </li> </ul> -<a name="newGauge(java.lang.String,java.lang.String,java.lang.Object)"> +<a name="newGauge-java.lang.String-java.lang.String-java.lang.Object-"> <!-- --> -</a><a name="newGauge(java.lang.String, java.lang.String, T)"> +</a><a name="newGauge-java.lang.String-java.lang.String-T-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newGauge</h4> <pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group, - java.lang.String name, - T value)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">MetricsRegistry</a></code></strong></div> + java.lang.String name, + T value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge-java.lang.String-java.lang.String-T-">MetricsRegistry</a></code></span></div> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> <dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> -<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>name</code> - Name of to-be-created Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd> -<dt><span class="strong">Returns:</span></dt><dd>Gauge was created and registered</dd></dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge-java.lang.String-java.lang.String-T-">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Type the Gauge will be wrapping</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Gauge</dd> +<dd><code>name</code> - Name of to-be-created Gauge</dd> +<dd><code>value</code> - Initial value for the Gauge</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Gauge was created and registered</dd> +</dl> </li> </ul> -<a name="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)"> +<a name="newGauge-java.lang.String-org.apache.samza.metrics.Gauge-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newGauge</h4> <pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">MetricsRegistry</a></code></strong></div> + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge-java.lang.String-org.apache.samza.metrics.Gauge-">MetricsRegistry</a></code></span></div> <div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> <dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> -<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>gauge</code> - Initial value for the Gauge</dd> -<dt><span class="strong">Returns:</span></dt><dd>Gauge was registered</dd></dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge-java.lang.String-org.apache.samza.metrics.Gauge-">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Type the Gauge will be wrapping</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Gauge</dd> +<dd><code>gauge</code> - Initial value for the Gauge</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Gauge was registered</dd> +</dl> </li> </ul> -<a name="newTimer(java.lang.String, java.lang.String)"> +<a name="newTimer-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newTimer</h4> <pre>public <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> newTimer(java.lang.String group, - java.lang.String name)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">MetricsRegistry</a></code></strong></div> + java.lang.String name)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer-java.lang.String-java.lang.String-">MetricsRegistry</a></code></span></div> <div class="block">Create and Register a new <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> <dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">newTimer</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Timer</dd><dd><code>name</code> - Name of to-be-created Timer</dd> -<dt><span class="strong">Returns:</span></dt><dd>New Timer instance</dd></dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer-java.lang.String-java.lang.String-">newTimer</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Timer</dd> +<dd><code>name</code> - Name of to-be-created Timer</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>New Timer instance</dd> +</dl> </li> </ul> -<a name="newTimer(java.lang.String, org.apache.samza.metrics.Timer)"> +<a name="newTimer-java.lang.String-org.apache.samza.metrics.Timer-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>newTimer</h4> <pre>public <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> newTimer(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">MetricsRegistry</a></code></strong></div> + <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer-java.lang.String-org.apache.samza.metrics.Timer-">MetricsRegistry</a></code></span></div> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> <dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">newTimer</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Timer</dd><dd><code>timer</code> - Existing Timer to register</dd> -<dt><span class="strong">Returns:</span></dt><dd>Timer that was registered</dd></dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer-java.lang.String-org.apache.samza.metrics.Timer-">newTimer</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Timer</dd> +<dd><code>timer</code> - Existing Timer to register</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Timer that was registered</dd> +</dl> </li> </ul> </li> @@ -334,9 +376,11 @@ 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><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"> @@ -351,15 +395,15 @@ implements <a href="../../../../org/apac </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/util/NoOpMetricsRegistry.html" target="_top">Frames</a></li> -<li><a href="NoOpMetricsRegistry.html" target="_top">No Frames</a></li> +<li><a href="NoOpMetricsRegistry.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"><!-- @@ -378,17 +422,17 @@ implements <a href="../../../../org/apac <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 ======= -->
