Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Snapshot.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Snapshot.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Snapshot.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Snapshot.html Wed Dec 10 00:54:42 2014 @@ -1,327 +1,345 @@ <!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 Fri Dec 05 10:56:59 PST 2014 --> -<title>Snapshot (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:23 PST 2014 --> +<TITLE> +Snapshot (samza-api 0.9.0-SNAPSHOT API) +</TITLE> + +<META NAME="date" CONTENT="2014-12-09"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Snapshot (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="Snapshot (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= 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"); +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/metrics/Snapshot.html" target="_top"><B>FRAMES</B></A> + <A HREF="Snapshot.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</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> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> + +<HR> <!-- ======== 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"> +<H2> +<FONT SIZE="-1"> +org.apache.samza.metrics</FONT> +<BR> +Class Snapshot</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.metrics.Snapshot</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>Snapshot</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +A statistical snapshot of a collection of values +<P> + +<P> +<HR> + +<P> + <!-- ======== 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> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html#Snapshot(java.util.Collection)">Snapshot</A></B>(java.util.Collection<java.lang.Long> values)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <!-- ========== 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"> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> double</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html#getAverage()">getAverage</A></B>()</CODE> + +<BR> + Get the average of the values in the collection</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html#getMax()">getMax</A></B>()</CODE> + +<BR> + Get the maximum value in the collection</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html#getMin()">getMin</A></B>()</CODE> + +<BR> + Get the minimum value in the collection</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html#getSize()">getSize</A></B>()</CODE> + +<BR> + Get the number of values in the collection</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.ArrayList<java.lang.Long></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html#getValues()">getValues</A></B>()</CODE> + +<BR> + Return the entire list of values</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + <!-- ========= 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> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="Snapshot(java.util.Collection)"><!-- --></A><H3> +Snapshot</H3> +<PRE> +public <B>Snapshot</B>(java.util.Collection<java.lang.Long> values)</PRE> +<DL> +</DL> + <!-- ============ 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> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getMax()"><!-- --></A><H3> +getMax</H3> +<PRE> +public long <B>getMax</B>()</PRE> +<DL> +<DD>Get the maximum value in the collection +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>maximum value</DL> +</DD> +</DL> +<HR> + +<A NAME="getMin()"><!-- --></A><H3> +getMin</H3> +<PRE> +public long <B>getMin</B>()</PRE> +<DL> +<DD>Get the minimum value in the collection +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>minimum value</DL> +</DD> +</DL> +<HR> + +<A NAME="getAverage()"><!-- --></A><H3> +getAverage</H3> +<PRE> +public double <B>getAverage</B>()</PRE> +<DL> +<DD>Get the average of the values in the collection +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>average value</DL> +</DD> +</DL> +<HR> + +<A NAME="getSize()"><!-- --></A><H3> +getSize</H3> +<PRE> +public int <B>getSize</B>()</PRE> +<DL> +<DD>Get the number of values in the collection +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>size of the collection</DL> +</DD> +</DL> +<HR> + +<A NAME="getValues()"><!-- --></A><H3> +getValues</H3> +<PRE> +public java.util.ArrayList<java.lang.Long> <B>getValues</B>()</PRE> +<DL> +<DD>Return the entire list of values +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the list of values</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> +<HR> + + <!-- ======= 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"); +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/metrics/Snapshot.html" target="_top"><B>FRAMES</B></A> + <A HREF="Snapshot.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</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> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML>
Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Timer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Timer.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Timer.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Timer.html Wed Dec 10 00:54:42 2014 @@ -1,359 +1,382 @@ <!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 Fri Dec 05 10:56:59 PST 2014 --> -<title>Timer (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:23 PST 2014 --> +<TITLE> +Timer (samza-api 0.9.0-SNAPSHOT API) +</TITLE> + +<META NAME="date" CONTENT="2014-12-09"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Timer (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="Timer (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= 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"); +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/metrics/Timer.html" target="_top"><B>FRAMES</B></A> + <A HREF="Timer.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</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> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> + +<HR> <!-- ======== 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"> +<H2> +<FONT SIZE="-1"> +org.apache.samza.metrics</FONT> +<BR> +Class Timer</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.metrics.Timer</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>Timer</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</A></DL> +</PRE> + +<P> +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. +<P> + +<P> +<HR> + +<P> + <!-- ======== 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> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#Timer(java.lang.String)">Timer</A></B>(java.lang.String name)</CODE> + +<BR> + Default constructor.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#Timer(java.lang.String, long, org.apache.samza.util.Clock)">Timer</A></B>(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> + +<BR> + 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</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#Timer(java.lang.String, org.apache.samza.metrics.Reservoir)">Timer</A></B>(java.lang.String name, + <A HREF="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</A> reservoir)</CODE> + +<BR> + 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></TD> +</TR> +</TABLE> + <!-- ========== 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"> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#getName()">getName</A></B>()</CODE> + +<BR> + Get the name of the timer</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#getSnapshot()">getSnapshot</A></B>()</CODE> + +<BR> + Get the <A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><CODE>Snapshot</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#update(long)">update</A></B>(long duration)</CODE> + +<BR> + Add the time duration</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Timer.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</A></B>(<A HREF="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</A> visitor)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + <!-- ========= 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> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="Timer(java.lang.String)"><!-- --></A><H3> +Timer</H3> +<PRE> +public <B>Timer</B>(java.lang.String name)</PRE> +<DL> +<DD>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. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of this timer</DL> +</DL> +<HR> + +<A NAME="Timer(java.lang.String, long, org.apache.samza.util.Clock)"><!-- --></A><H3> +Timer</H3> +<PRE> +public <B>Timer</B>(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> +<DL> +<DD>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 +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of this timer<DD><CODE>windowMs</CODE> - the window size. unit is millisecond<DD><CODE>clock</CODE> - the clock for the reservoir</DL> +</DL> +<HR> + +<A NAME="Timer(java.lang.String, org.apache.samza.metrics.Reservoir)"><!-- --></A><H3> +Timer</H3> +<PRE> +public <B>Timer</B>(java.lang.String name, + <A HREF="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</A> reservoir)</PRE> +<DL> +<DD>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> +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of this timer<DD><CODE>reservoir</CODE> - the given reservoir</DL> +</DL> + <!-- ============ 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> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="update(long)"><!-- --></A><H3> +update</H3> +<PRE> +public void <B>update</B>(long duration)</PRE> +<DL> +<DD>Add the time duration +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>duration</CODE> - time duration</DL> +</DD> +</DL> +<HR> + +<A NAME="getSnapshot()"><!-- --></A><H3> +getSnapshot</H3> +<PRE> +public <A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</A> <B>getSnapshot</B>()</PRE> +<DL> +<DD>Get the <A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><CODE>Snapshot</CODE></A> +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>a statistical snapshot</DL> +</DD> +</DL> +<HR> + +<A NAME="visit(org.apache.samza.metrics.MetricsVisitor)"><!-- --></A><H3> +visit</H3> +<PRE> +public void <B>visit</B>(<A HREF="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</A> visitor)</PRE> +<DL> +<DD><DL> +<DT><B>Specified by:</B><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></DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getName()"><!-- --></A><H3> +getName</H3> +<PRE> +public java.lang.String <B>getName</B>()</PRE> +<DL> +<DD>Get the name of the timer +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>name of the timer</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> +<HR> + + <!-- ======= 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"); +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/metrics/Timer.html" target="_top"><B>FRAMES</B></A> + <A HREF="Timer.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</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> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-frame.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-frame.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-frame.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-frame.html Wed Dec 10 00:54:42 2014 @@ -1,34 +1,65 @@ <!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 Fri Dec 05 10:56:59 PST 2014 --> -<title>org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-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> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +org.apache.samza.metrics (samza-api 0.9.0-SNAPSHOT API) +</TITLE> + +<META NAME="date" CONTENT="2014-12-09"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + + +</HEAD> + +<BODY BGCOLOR="white"> +<FONT size="+1" CLASS="FrameTitleFont"> +<A HREF="../../../../org/apache/samza/metrics/package-summary.html" target="classFrame">org.apache.samza.metrics</A></FONT> +<TABLE BORDER="0" WIDTH="100%" SUMMARY=""> +<TR> +<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont"> +Interfaces</FONT> +<FONT CLASS="FrameItemFont"> +<BR> +<A HREF="Metric.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>Metric</I></A> +<BR> +<A HREF="MetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>MetricsRegistry</I></A> +<BR> +<A HREF="MetricsReporter.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>MetricsReporter</I></A> +<BR> +<A HREF="MetricsReporterFactory.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>MetricsReporterFactory</I></A> +<BR> +<A HREF="ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>ReadableMetricsRegistry</I></A> +<BR> +<A HREF="ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>ReadableMetricsRegistryListener</I></A> +<BR> +<A HREF="Reservoir.html" title="interface in org.apache.samza.metrics" target="classFrame"><I>Reservoir</I></A></FONT></TD> +</TR> +</TABLE> + + +<TABLE BORDER="0" WIDTH="100%" SUMMARY=""> +<TR> +<TD NOWRAP><FONT size="+1" CLASS="FrameHeadingFont"> +Classes</FONT> +<FONT CLASS="FrameItemFont"> +<BR> +<A HREF="Counter.html" title="class in org.apache.samza.metrics" target="classFrame">Counter</A> +<BR> +<A HREF="Gauge.html" title="class in org.apache.samza.metrics" target="classFrame">Gauge</A> +<BR> +<A HREF="MetricsVisitor.html" title="class in org.apache.samza.metrics" target="classFrame">MetricsVisitor</A> +<BR> +<A HREF="SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics" target="classFrame">SlidingTimeWindowReservoir</A> +<BR> +<A HREF="Snapshot.html" title="class in org.apache.samza.metrics" target="classFrame">Snapshot</A> +<BR> +<A HREF="Timer.html" title="class in org.apache.samza.metrics" target="classFrame">Timer</A></FONT></TD> +</TR> +</TABLE> + + +</BODY> +</HTML> Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-summary.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-summary.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-summary.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/package-summary.html Wed Dec 10 00:54:42 2014 @@ -1,221 +1,220 @@ <!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 Fri Dec 05 10:56:59 PST 2014 --> -<title>org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-12-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_65) on Tue Dec 09 16:53:24 PST 2014 --> +<TITLE> +org.apache.samza.metrics (samza-api 0.9.0-SNAPSHOT API) +</TITLE> + +<META NAME="date" CONTENT="2014-12-09"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.samza.metrics (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="org.apache.samza.metrics (samza-api 0.9.0-SNAPSHOT API)"; } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + <!-- ========= 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"); +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/job/package-summary.html"><B>PREV PACKAGE</B></A> + <A HREF="../../../../org/apache/samza/serializers/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/metrics/package-summary.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> <!-- ========= 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> + +<HR> +<H2> +Package org.apache.samza.metrics +</H2> + +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Interface Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</A></B></TD> +<TD>Metric class that allows metric visitors to visit it to get its information.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</A></B></TD> +<TD>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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics">MetricsReporter</A></B></TD> +<TD>A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive + metrics from the Samza framework and Samza jobs.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics">MetricsReporterFactory</A></B></TD> +<TD>Build a <A HREF="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><CODE>MetricsReporter</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</A></B></TD> +<TD>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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistryListener</A></B></TD> +<TD> </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics">Reservoir</A></B></TD> +<TD>A reservoir interface to store, update and display values</TD> +</TR> +</TABLE> + + +<P> + +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Class Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A></B></TD> +<TD>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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge<T></A></B></TD> +<TD>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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</A></B></TD> +<TD>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.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics">SlidingTimeWindowReservoir</A></B></TD> +<TD>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</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</A></B></TD> +<TD>A statistical snapshot of a collection of values</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD WIDTH="15%"><B><A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A></B></TD> +<TD>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.</TD> +</TR> +</TABLE> + + +<P> +<DL> +</DL> +<HR> + + <!-- ======= 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"); +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../org/apache/samza/job/package-summary.html"><B>PREV PACKAGE</B></A> + <A HREF="../../../../org/apache/samza/serializers/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/apache/samza/metrics/package-summary.html" target="_top"><B>FRAMES</B></A> + <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; + document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> -</script> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> + +<HR> + +</BODY> +</HTML>
