http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/SlidingTimeWindowReservoir.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/SlidingTimeWindowReservoir.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/SlidingTimeWindowReservoir.html deleted file mode 100644 index afeeb59..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/SlidingTimeWindowReservoir.html +++ /dev/null @@ -1,344 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:33 PDT 2014 --> -<title>SlidingTimeWindowReservoir (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="SlidingTimeWindowReservoir (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/SlidingTimeWindowReservoir.html" target="_top">Frames</a></li> -<li><a href="SlidingTimeWindowReservoir.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.metrics</div> -<h2 title="Class SlidingTimeWindowReservoir" class="title">Class SlidingTimeWindowReservoir</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.metrics.SlidingTimeWindowReservoir</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="strong">SlidingTimeWindowReservoir</span> -extends java.lang.Object -implements <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></pre> -<div class="block">An implemented <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><code>Reservoir</code></a> used to store values that appear in a - sliding time window</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html#SlidingTimeWindowReservoir()">SlidingTimeWindowReservoir</a></strong>()</code> -<div class="block">Default constructor using default window size</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html#SlidingTimeWindowReservoir(long)">SlidingTimeWindowReservoir</a></strong>(long windowMs)</code> -<div class="block">Construct the SlidingTimeWindowReservoir with window size</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html#SlidingTimeWindowReservoir(long,%20org.apache.samza.util.Clock)">SlidingTimeWindowReservoir</a></strong>(long windowMs, - <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html#getSnapshot()">getSnapshot</a></strong>()</code> -<div class="block">Return a <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a> of this reservoir</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html#size()">size</a></strong>()</code> -<div class="block">Return the number of values in this reservoir</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html#update(long)">update</a></strong>(long value)</code> -<div class="block">Update the reservoir with the new value</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="SlidingTimeWindowReservoir()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>SlidingTimeWindowReservoir</h4> -<pre>public SlidingTimeWindowReservoir()</pre> -<div class="block">Default constructor using default window size</div> -</li> -</ul> -<a name="SlidingTimeWindowReservoir(long)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>SlidingTimeWindowReservoir</h4> -<pre>public SlidingTimeWindowReservoir(long windowMs)</pre> -<div class="block">Construct the SlidingTimeWindowReservoir with window size</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>windowMs</code> - the size of the window. unit is millisecond.</dd></dl> -</li> -</ul> -<a name="SlidingTimeWindowReservoir(long, org.apache.samza.util.Clock)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>SlidingTimeWindowReservoir</h4> -<pre>public SlidingTimeWindowReservoir(long windowMs, - <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="size()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>size</h4> -<pre>public int size()</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/Reservoir.html#size()">Reservoir</a></code></strong></div> -<div class="block">Return the number of values in this reservoir</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/Reservoir.html#size()">size</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>the number of values;</dd></dl> -</li> -</ul> -<a name="update(long)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>update</h4> -<pre>public void update(long value)</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/Reservoir.html#update(long)">Reservoir</a></code></strong></div> -<div class="block">Update the reservoir with the new value</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/Reservoir.html#update(long)">update</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></code></dd> -</dl> -</li> -</ul> -<a name="getSnapshot()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getSnapshot</h4> -<pre>public <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a> getSnapshot()</pre> -<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/Reservoir.html#getSnapshot()">Reservoir</a></code></strong></div> -<div class="block">Return a <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a> of this reservoir</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/Reservoir.html#getSnapshot()">getSnapshot</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>a statistical snapshot of this reservoir</dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/SlidingTimeWindowReservoir.html" target="_top">Frames</a></li> -<li><a href="SlidingTimeWindowReservoir.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Snapshot.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Snapshot.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Snapshot.html deleted file mode 100644 index 66324fc..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Snapshot.html +++ /dev/null @@ -1,327 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>Snapshot (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Snapshot (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/Snapshot.html" target="_top">Frames</a></li> -<li><a href="Snapshot.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.metrics</div> -<h2 title="Class Snapshot" class="title">Class Snapshot</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.metrics.Snapshot</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="strong">Snapshot</span> -extends java.lang.Object</pre> -<div class="block">A statistical snapshot of a collection of values</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/Snapshot.html#Snapshot(java.util.Collection)">Snapshot</a></strong>(java.util.Collection<java.lang.Long> values)</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>double</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Snapshot.html#getAverage()">getAverage</a></strong>()</code> -<div class="block">Get the average of the values in the collection</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Snapshot.html#getMax()">getMax</a></strong>()</code> -<div class="block">Get the maximum value in the collection</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Snapshot.html#getMin()">getMin</a></strong>()</code> -<div class="block">Get the minimum value in the collection</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Snapshot.html#getSize()">getSize</a></strong>()</code> -<div class="block">Get the number of values in the collection</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.util.ArrayList<java.lang.Long></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Snapshot.html#getValues()">getValues</a></strong>()</code> -<div class="block">Return the entire list of values</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="Snapshot(java.util.Collection)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Snapshot</h4> -<pre>public Snapshot(java.util.Collection<java.lang.Long> values)</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getMax()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMax</h4> -<pre>public long getMax()</pre> -<div class="block">Get the maximum value in the collection</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>maximum value</dd></dl> -</li> -</ul> -<a name="getMin()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMin</h4> -<pre>public long getMin()</pre> -<div class="block">Get the minimum value in the collection</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>minimum value</dd></dl> -</li> -</ul> -<a name="getAverage()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getAverage</h4> -<pre>public double getAverage()</pre> -<div class="block">Get the average of the values in the collection</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>average value</dd></dl> -</li> -</ul> -<a name="getSize()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSize</h4> -<pre>public int getSize()</pre> -<div class="block">Get the number of values in the collection</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>size of the collection</dd></dl> -</li> -</ul> -<a name="getValues()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getValues</h4> -<pre>public java.util.ArrayList<java.lang.Long> getValues()</pre> -<div class="block">Return the entire list of values</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the list of values</dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/Snapshot.html" target="_top">Frames</a></li> -<li><a href="Snapshot.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Timer.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Timer.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Timer.html deleted file mode 100644 index fc5f305..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/Timer.html +++ /dev/null @@ -1,359 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>Timer (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Timer (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/Timer.html" target="_top">Frames</a></li> -<li><a href="Timer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.metrics</div> -<h2 title="Class Timer" class="title">Class Timer</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.metrics.Timer</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="strong">Timer</span> -extends java.lang.Object -implements <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></pre> -<div class="block">A timer metric that stores time duration and provides <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a> of the - durations.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#Timer(java.lang.String)">Timer</a></strong>(java.lang.String name)</code> -<div class="block">Default constructor.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#Timer(java.lang.String,%20long,%20org.apache.samza.util.Clock)">Timer</a></strong>(java.lang.String name, - long windowMs, - <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> -<div class="block">Construct a <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with given window size</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#Timer(java.lang.String,%20org.apache.samza.metrics.Reservoir)">Timer</a></strong>(java.lang.String name, - <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a> reservoir)</code> -<div class="block">Construct a <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with given <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><code>Reservoir</code></a></div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#getName()">getName</a></strong>()</code> -<div class="block">Get the name of the timer</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#getSnapshot()">getSnapshot</a></strong>()</code> -<div class="block">Get the <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a></div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#update(long)">update</a></strong>(long duration)</code> -<div class="block">Add the time duration</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Timer.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</code> </td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="Timer(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Timer</h4> -<pre>public Timer(java.lang.String name)</pre> -<div class="block">Default constructor. It uses <a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics"><code>SlidingTimeWindowReservoir</code></a> as the - default reservoir.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of this timer</dd></dl> -</li> -</ul> -<a name="Timer(java.lang.String, long, org.apache.samza.util.Clock)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Timer</h4> -<pre>public Timer(java.lang.String name, - long windowMs, - <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre> -<div class="block">Construct a <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with given window size</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of this timer</dd><dd><code>windowMs</code> - the window size. unit is millisecond</dd><dd><code>clock</code> - the clock for the reservoir</dd></dl> -</li> -</ul> -<a name="Timer(java.lang.String, org.apache.samza.metrics.Reservoir)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Timer</h4> -<pre>public Timer(java.lang.String name, - <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a> reservoir)</pre> -<div class="block">Construct a <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with given <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><code>Reservoir</code></a></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of this timer</dd><dd><code>reservoir</code> - the given reservoir</dd></dl> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="update(long)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>update</h4> -<pre>public void update(long duration)</pre> -<div class="block">Add the time duration</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duration</code> - time duration</dd></dl> -</li> -</ul> -<a name="getSnapshot()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSnapshot</h4> -<pre>public <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a> getSnapshot()</pre> -<div class="block">Get the <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a></div> -<dl><dt><span class="strong">Returns:</span></dt><dd>a statistical snapshot</dd></dl> -</li> -</ul> -<a name="visit(org.apache.samza.metrics.MetricsVisitor)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>visit</h4> -<pre>public void visit(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</pre> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/Metric.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></code></dd> -</dl> -</li> -</ul> -<a name="getName()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getName</h4> -<pre>public java.lang.String getName()</pre> -<div class="block">Get the name of the timer</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>name of the timer</dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/Timer.html" target="_top">Frames</a></li> -<li><a href="Timer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-frame.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-frame.html deleted file mode 100644 index d1123a3..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-frame.html +++ /dev/null @@ -1,34 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<h1 class="bar"><a href="../../../../org/apache/samza/metrics/package-summary.html" target="classFrame">org.apache.samza.metrics</a></h1> -<div class="indexContainer"> -<h2 title="Interfaces">Interfaces</h2> -<ul title="Interfaces"> -<li><a href="Metric.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>Metric</i></a></li> -<li><a href="MetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsRegistry</i></a></li> -<li><a href="MetricsReporter.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsReporter</i></a></li> -<li><a href="MetricsReporterFactory.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsReporterFactory</i></a></li> -<li><a href="ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>ReadableMetricsRegistry</i></a></li> -<li><a href="ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>ReadableMetricsRegistryListener</i></a></li> -<li><a href="Reservoir.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>Reservoir</i></a></li> -</ul> -<h2 title="Classes">Classes</h2> -<ul title="Classes"> -<li><a href="Counter.html" title="class in org.apache.samza.metrics" target="classFrame">Counter</a></li> -<li><a href="Gauge.html" title="class in org.apache.samza.metrics" target="classFrame">Gauge</a></li> -<li><a href="MetricsVisitor.html" title="class in org.apache.samza.metrics" target="classFrame">MetricsVisitor</a></li> -<li><a href="SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics" target="classFrame">SlidingTimeWindowReservoir</a></li> -<li><a href="Snapshot.html" title="class in org.apache.samza.metrics" target="classFrame">Snapshot</a></li> -<li><a href="Timer.html" title="class in org.apache.samza.metrics" target="classFrame">Timer</a></li> -</ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-summary.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-summary.html deleted file mode 100644 index 1d666f9..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-summary.html +++ /dev/null @@ -1,221 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li class="navBarCell1Rev">Package</li> -<li>Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/job/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/serializers/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Package" class="title">Package org.apache.samza.metrics</h1> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> -<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Interface</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></td> -<td class="colLast"> -<div class="block">Metric class that allows metric visitors to visit it to get its information.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></td> -<td class="colLast"> -<div class="block">A MetricsRegistry allows its users to create new <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a>s and - have those metrics wired to specific metrics systems, such as JMX, provided by <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics">MetricsReporter</a></td> -<td class="colLast"> -<div class="block">A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive - metrics from the Samza framework and Samza jobs.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics">MetricsReporterFactory</a></td> -<td class="colLast"> -<div class="block">Build a <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a></div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></td> -<td class="colLast"> -<div class="block">A ReadableMetricsRegistry is a <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> that also - allows read access to the metrics for which it is responsible.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistryListener</a></td> -<td class="colLast"> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a></td> -<td class="colLast"> -<div class="block">A reservoir interface to store, update and display values</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> -<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Class</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></td> -<td class="colLast"> -<div class="block">A counter is a <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that represents a cumulative value.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></td> -<td class="colLast"> -<div class="block">A Gauge is a <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a> that wraps some instance of T in a thread-safe - reference and allows it to be set or retrieved.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></td> -<td class="colLast"> -<div class="block">A MetricsVisitor can be used to process each metric in a <a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>ReadableMetricsRegistry</code></a>, - encapsulating the logic of what to be done with each metric in the counter and gauge methods.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics">SlidingTimeWindowReservoir</a></td> -<td class="colLast"> -<div class="block">An implemented <a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><code>Reservoir</code></a> used to store values that appear in a - sliding time window</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></td> -<td class="colLast"> -<div class="block">A statistical snapshot of a collection of values</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></td> -<td class="colLast"> -<div class="block">A timer metric that stores time duration and provides <a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><code>Snapshot</code></a> of the - durations.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li class="navBarCell1Rev">Package</li> -<li>Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/job/package-summary.html">Prev Package</a></li> -<li><a href="../../../../org/apache/samza/serializers/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-tree.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-tree.html deleted file mode 100644 index 63d0142..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/metrics/package-tree.html +++ /dev/null @@ -1,144 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza.metrics Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.metrics Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li>Class</li> -<li class="navBarCell1Rev">Tree</li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/job/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/serializers/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/package-tree.html" target="_top">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> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 class="title">Hierarchy For Package org.apache.samza.metrics</h1> -<span class="strong">Package Hierarchies:</span> -<ul class="horizontal"> -<li><a href="../../../../overview-tree.html">All Packages</a></li> -</ul> -</div> -<div class="contentContainer"> -<h2 title="Class Hierarchy">Class Hierarchy</h2> -<ul> -<li type="circle">java.lang.Object -<ul> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Counter</span></a> (implements org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a>)</li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Gauge</span></a><T> (implements org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a>)</li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="strong">MetricsVisitor</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics"><span class="strong">SlidingTimeWindowReservoir</span></a> (implements org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</a>)</li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><span class="strong">Snapshot</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><span class="strong">Timer</span></a> (implements org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a>)</li> -</ul> -</li> -</ul> -<h2 title="Interface Hierarchy">Interface Hierarchy</h2> -<ul> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Metric</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsRegistry</span></a> -<ul> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">ReadableMetricsRegistry</span></a></li> -</ul> -</li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporter</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">MetricsReporterFactory</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics"><span class="strong">ReadableMetricsRegistryListener</span></a></li> -<li type="circle">org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><span class="strong">Reservoir</span></a></li> -</ul> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li>Class</li> -<li class="navBarCell1Rev">Tree</li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../org/apache/samza/job/package-tree.html">Prev</a></li> -<li><a href="../../../../org/apache/samza/serializers/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/metrics/package-tree.html" target="_top">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> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-frame.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-frame.html deleted file mode 100644 index 75bd103..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -</head> -<body> -<h1 class="bar"><a href="../../../org/apache/samza/package-summary.html" target="classFrame">org.apache.samza</a></h1> -<div class="indexContainer"> -<h2 title="Classes">Classes</h2> -<ul title="Classes"> -<li><a href="Partition.html" title="class in org.apache.samza" target="classFrame">Partition</a></li> -</ul> -<h2 title="Exceptions">Exceptions</h2> -<ul title="Exceptions"> -<li><a href="SamzaException.html" title="class in org.apache.samza" target="classFrame">SamzaException</a></li> -</ul> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-summary.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-summary.html deleted file mode 100644 index 108c5e2..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-summary.html +++ /dev/null @@ -1,150 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li class="navBarCell1Rev">Package</li> -<li>Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../index-all.html">Index</a></li> -<li><a href="../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Package</li> -<li><a href="../../../org/apache/samza/checkpoint/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/samza/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 title="Package" class="title">Package org.apache.samza</h1> -</div> -<div class="contentContainer"> -<ul class="blockList"> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> -<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Class</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></td> -<td class="colLast"> -<div class="block">A numbered, ordered partition of a stream.</div> -</td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"> -<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> -<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Exception</th> -<th class="colLast" scope="col">Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colFirst"><a href="../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza">SamzaException</a></td> -<td class="colLast"> -<div class="block">Unchecked exception that Samza throws when something goes wrong.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li class="navBarCell1Rev">Package</li> -<li>Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../index-all.html">Index</a></li> -<li><a href="../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Package</li> -<li><a href="../../../org/apache/samza/checkpoint/package-summary.html">Next Package</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/samza/package-summary.html" target="_top">Frames</a></li> -<li><a href="package-summary.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-tree.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-tree.html deleted file mode 100644 index 2a3c15e..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/package-tree.html +++ /dev/null @@ -1,139 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>org.apache.samza Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li>Class</li> -<li class="navBarCell1Rev">Tree</li> -<li><a href="../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../index-all.html">Index</a></li> -<li><a href="../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li><a href="../../../org/apache/samza/checkpoint/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/samza/package-tree.html" target="_top">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> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<div class="header"> -<h1 class="title">Hierarchy For Package org.apache.samza</h1> -<span class="strong">Package Hierarchies:</span> -<ul class="horizontal"> -<li><a href="../../../overview-tree.html">All Packages</a></li> -</ul> -</div> -<div class="contentContainer"> -<h2 title="Class Hierarchy">Class Hierarchy</h2> -<ul> -<li type="circle">java.lang.Object -<ul> -<li type="circle">org.apache.samza.<a href="../../../org/apache/samza/Partition.html" title="class in org.apache.samza"><span class="strong">Partition</span></a> (implements java.lang.Comparable<T>)</li> -<li type="circle">java.lang.Throwable (implements java.io.Serializable) -<ul> -<li type="circle">java.lang.Exception -<ul> -<li type="circle">java.lang.RuntimeException -<ul> -<li type="circle">org.apache.samza.<a href="../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza"><span class="strong">SamzaException</span></a></li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li>Class</li> -<li class="navBarCell1Rev">Tree</li> -<li><a href="../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../index-all.html">Index</a></li> -<li><a href="../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev</li> -<li><a href="../../../org/apache/samza/checkpoint/package-tree.html">Next</a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?org/apache/samza/package-tree.html" target="_top">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> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/cf90e33a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Deserializer.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Deserializer.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Deserializer.html deleted file mode 100644 index a8588f7..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/serializers/Deserializer.html +++ /dev/null @@ -1,216 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> -<title>Deserializer (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Deserializer (samza-api 0.8.0-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/Deserializer.html" target="_top">Frames</a></li> -<li><a href="Deserializer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </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> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.serializers</div> -<h2 title="Interface Deserializer" class="title">Interface Deserializer<T></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of serialized object implementations can read</dd></dl> -<dl> -<dt>All Known Subinterfaces:</dt> -<dd><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers">Serde</a><T></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="strong">Deserializer<T></span></pre> -<div class="block">A standard interface for Samza compatible deserializers, used for deserializing serialized objects back to their - original form.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/serializers/Deserializer.html" title="type parameter in Deserializer">T</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/serializers/Deserializer.html#fromBytes(byte[])">fromBytes</a></strong>(byte[] bytes)</code> -<div class="block">Deserializes given serialized object from an array of bytes to its original form.</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="fromBytes(byte[])"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>fromBytes</h4> -<pre><a href="../../../../org/apache/samza/serializers/Deserializer.html" title="type parameter in Deserializer">T</a> fromBytes(byte[] bytes)</pre> -<div class="block">Deserializes given serialized object from an array of bytes to its original form.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - Array of bytes representing serialized object.</dd> -<dt><span class="strong">Returns:</span></dt><dd>Original deserialized object.</dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../index-all.html">Index</a></li> -<li><a href="../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li>Prev Class</li> -<li><a href="../../../../org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/serializers/Deserializer.html" target="_top">Frames</a></li> -<li><a href="Deserializer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </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> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
