Modified: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Gauge.html Wed Dec 10 00:54:42 2014 @@ -1,350 +1,381 @@ <!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>Gauge (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> +Gauge (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="Gauge (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="Gauge (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/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface 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/Gauge.html" target="_top">Frames</a></li> -<li><a href="Gauge.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/Counter.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/Metric.html" title="interface 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/Gauge.html" target="_top"><B>FRAMES</B></A> + <A HREF="Gauge.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 Gauge" class="title">Class Gauge<T></h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.metrics.Gauge<T></li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Instance to be wrapped in the gauge for metering.</dd></dl> -<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> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="strong">Gauge<T></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 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 +<H2> +<FONT SIZE="-1"> +org.apache.samza.metrics</FONT> +<BR> +Class Gauge<T></H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.samza.metrics.Gauge<T></B> +</PRE> +<DL> +<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - Instance to be wrapped in the gauge for metering.</DL> +<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> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>Gauge<T></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 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. Gauges record specific values over time. - For example, the current length of a queue or the size of a buffer.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> + For example, the current length of a queue or the size of a buffer. +<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/Gauge.html#Gauge(java.lang.String,%20T)">Gauge</a></strong>(java.lang.String name, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> value)</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/Gauge.html#Gauge(java.lang.String, T)">Gauge</A></B>(java.lang.String name, + <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> value)</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>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet</a></strong>(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> expected, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#getName()">getName</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#getValue()">getValue</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</a></strong>(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.html#toString()">toString</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Gauge.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, 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> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T, T)">compareAndSet</A></B>(<A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> expected, + <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> n)</CODE> + +<BR> + </TD> +</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/Gauge.html#getName()">getName</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Gauge.html#getValue()">getValue</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</A></B>(<A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> n)</CODE> + +<BR> + </TD> +</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/Gauge.html#toString()">toString</A></B>()</CODE> + +<BR> + </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/Gauge.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, 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="Gauge(java.lang.String,java.lang.Object)"> -<!-- --> -</a><a name="Gauge(java.lang.String, T)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Gauge</h4> -<pre>public Gauge(java.lang.String name, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> value)</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="Gauge(java.lang.String,java.lang.Object)"><!-- --></A><A NAME="Gauge(java.lang.String, T)"><!-- --></A><H3> +Gauge</H3> +<PRE> +public <B>Gauge</B>(java.lang.String name, + <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> value)</PRE> +<DL> +</DL> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="compareAndSet(java.lang.Object,java.lang.Object)"> -<!-- --> -</a><a name="compareAndSet(T, T)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>compareAndSet</h4> -<pre>public boolean compareAndSet(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> expected, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</pre> -</li> -</ul> -<a name="set(java.lang.Object)"> -<!-- --> -</a><a name="set(T)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>set</h4> -<pre>public <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> set(<a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> n)</pre> -</li> -</ul> -<a name="getValue()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getValue</h4> -<pre>public <a href="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</a> getValue()</pre> -</li> -</ul> -<a name="getName()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getName</h4> -<pre>public java.lang.String getName()</pre> -</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="toString()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></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="compareAndSet(java.lang.Object,java.lang.Object)"><!-- --></A><A NAME="compareAndSet(T, T)"><!-- --></A><H3> +compareAndSet</H3> +<PRE> +public boolean <B>compareAndSet</B>(<A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> expected, + <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> n)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="set(java.lang.Object)"><!-- --></A><A NAME="set(T)"><!-- --></A><H3> +set</H3> +<PRE> +public <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> <B>set</B>(<A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> n)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getValue()"><!-- --></A><H3> +getValue</H3> +<PRE> +public <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="type parameter in Gauge">T</A> <B>getValue</B>()</PRE> +<DL> +<DD><DL> +</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><DL> +</DL> +</DD> +<DD><DL> +</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="toString()"><!-- --></A><H3> +toString</H3> +<PRE> +public java.lang.String <B>toString</B>()</PRE> +<DL> +<DD><DL> +<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> +</DD> +<DD><DL> +</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/Counter.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface 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/Gauge.html" target="_top">Frames</a></li> -<li><a href="Gauge.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/Counter.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/Metric.html" title="interface 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/Gauge.html" target="_top"><B>FRAMES</B></A> + <A HREF="Gauge.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/Metric.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Metric.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Metric.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/Metric.html Wed Dec 10 00:54:42 2014 @@ -1,209 +1,211 @@ <!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>Metric (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> +Metric (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="Metric (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="Metric (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/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface 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/Metric.html" target="_top">Frames</a></li> -<li><a href="Metric.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/Gauge.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface 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/Metric.html" target="_top"><B>FRAMES</B></A> + <A HREF="Metric.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>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> +</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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <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="Interface Metric" class="title">Interface Metric</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a>, <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a>, <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="strong">Metric</span></pre> -<div class="block">Metric class that allows metric visitors to visit it to get its information.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> +<H2> +<FONT SIZE="-1"> +org.apache.samza.metrics</FONT> +<BR> +Interface Metric</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</A>, <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A>, <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A>, <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>Metric</B></DL> +</PRE> + +<P> +Metric class that allows metric visitors to visit it to get its information. +<P> + +<P> +<HR> + +<P> + <!-- ========== 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>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/Metric.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> -</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> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/Metric.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> + +<P> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="visit(org.apache.samza.metrics.MetricsVisitor)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>visit</h4> -<pre>void visit(<a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a> visitor)</pre> -</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="visit(org.apache.samza.metrics.MetricsVisitor)"><!-- --></A><H3> +visit</H3> +<PRE> +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> +</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/Gauge.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface 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/Metric.html" target="_top">Frames</a></li> -<li><a href="Metric.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/Gauge.html" title="class in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface 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/Metric.html" target="_top"><B>FRAMES</B></A> + <A HREF="Metric.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>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> +</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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <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/MetricsRegistry.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html?rev=1644267&r1=1644266&r2=1644267&view=diff ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html (original) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html Wed Dec 10 00:54:42 2014 @@ -1,330 +1,361 @@ <!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>MetricsRegistry (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> +MetricsRegistry (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="MetricsRegistry (samza-api 0.8.0-SNAPSHOT API)"; + parent.document.title="MetricsRegistry (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/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface 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/MetricsRegistry.html" target="_top">Frames</a></li> -<li><a href="MetricsRegistry.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/Metric.html" title="interface in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface 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/MetricsRegistry.html" target="_top"><B>FRAMES</B></A> + <A HREF="MetricsRegistry.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>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> +</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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <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="Interface MetricsRegistry" class="title">Interface MetricsRegistry</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Known Subinterfaces:</dt> -<dd><a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a></dd> -</dl> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="strong">MetricsRegistry</span></pre> -<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. +<H2> +<FONT SIZE="-1"> +org.apache.samza.metrics</FONT> +<BR> +Interface MetricsRegistry</H2> +<DL> +<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</A></DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>MetricsRegistry</B></DL> +</PRE> + +<P> +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. Those implementing Samza jobs use the MetricsRegistry to register metrics, which then handle the details of getting those metrics to each defined MetricsReporter. - Users are free to define their metrics into groups as needed for their jobs. <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s - will likely use the group field to group the user-defined metrics together.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> + Users are free to define their metrics into groups as needed for their jobs. <A HREF="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><CODE>MetricsReporter</CODE></A>s + will likely use the group field to group the user-defined metrics together. +<P> + +<P> +<HR> + +<P> + <!-- ========== 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/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code> -<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></strong>(java.lang.String group, - java.lang.String name)</code> -<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> value)</code> -<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></strong>(java.lang.String group, - java.lang.String name, - T value)</code> -<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">newTimer</a></strong>(java.lang.String group, - java.lang.String name)</code> -<div class="block">Create and Register a new <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">newTimer</a></strong>(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</code> -<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> -</td> -</tr> -</table> -</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> <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, org.apache.samza.metrics.Counter)">newCounter</A></B>(java.lang.String group, + <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A> counter)</CODE> + +<BR> + Register existing <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><CODE>Counter</CODE></A> with this registry</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">newCounter</A></B>(java.lang.String group, + java.lang.String name)</CODE> + +<BR> + Create and register a new <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><CODE>Counter</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR ALIGN="right" VALIGN=""> +<TD NOWRAP><FONT SIZE="-1"> +<CODE><T> <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A><T></CODE></FONT></TD> +</TR> +</TABLE> +</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">newGauge</A></B>(java.lang.String group, + <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A><T> value)</CODE> + +<BR> + Register an existing <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><CODE>Gauge</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> +<TR ALIGN="right" VALIGN=""> +<TD NOWRAP><FONT SIZE="-1"> +<CODE><T> <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A><T></CODE></FONT></TD> +</TR> +</TABLE> +</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">newGauge</A></B>(java.lang.String group, + java.lang.String name, + T value)</CODE> + +<BR> + Create and register a new <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><CODE>Gauge</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String, java.lang.String)">newTimer</A></B>(java.lang.String group, + java.lang.String name)</CODE> + +<BR> + Create and Register a new <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><CODE>Timer</CODE></A></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String, org.apache.samza.metrics.Timer)">newTimer</A></B>(java.lang.String group, + <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A> timer)</CODE> + +<BR> + Register existing <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><CODE>Timer</CODE></A> with this registry</TD> +</TR> +</TABLE> + +<P> + <!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="newCounter(java.lang.String, java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newCounter</h4> -<pre><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group, - java.lang.String name)</pre> -<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>name</code> - Name of to-be-created Counter</dd> -<dt><span class="strong">Returns:</span></dt><dd>New Counter instance</dd></dl> -</li> -</ul> -<a name="newCounter(java.lang.String, org.apache.samza.metrics.Counter)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newCounter</h4> -<pre><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre> -<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>counter</code> - Existing Counter to register</dd> -<dt><span class="strong">Returns:</span></dt><dd>Counter that was registered</dd></dl> -</li> -</ul> -<a name="newGauge(java.lang.String,java.lang.String,java.lang.Object)"> -<!-- --> -</a><a name="newGauge(java.lang.String, java.lang.String, T)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newGauge</h4> -<pre><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group, - java.lang.String name, - T value)</pre> -<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>name</code> - Name of to-be-created Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd> -<dt><span class="strong">Returns:</span></dt><dd>Gauge was created and registered</dd></dl> -</li> -</ul> -<a name="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newGauge</h4> -<pre><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> value)</pre> -<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd> -<dt><span class="strong">Returns:</span></dt><dd>Gauge was registered</dd></dl> -</li> -</ul> -<a name="newTimer(java.lang.String, java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>newTimer</h4> -<pre><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> newTimer(java.lang.String group, - java.lang.String name)</pre> -<div class="block">Create and Register a new <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Timer</dd><dd><code>name</code> - Name of to-be-created Timer</dd> -<dt><span class="strong">Returns:</span></dt><dd>New Timer instance</dd></dl> -</li> -</ul> -<a name="newTimer(java.lang.String, org.apache.samza.metrics.Timer)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>newTimer</h4> -<pre><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> newTimer(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</pre> -<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Timer</dd><dd><code>timer</code> - Existing Timer to register</dd> -<dt><span class="strong">Returns:</span></dt><dd>Timer that was registered</dd></dl> -</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="newCounter(java.lang.String, java.lang.String)"><!-- --></A><H3> +newCounter</H3> +<PRE> +<A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A> <B>newCounter</B>(java.lang.String group, + java.lang.String name)</PRE> +<DL> +<DD>Create and register a new <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><CODE>Counter</CODE></A> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>group</CODE> - Group for this Counter<DD><CODE>name</CODE> - Name of to-be-created Counter +<DT><B>Returns:</B><DD>New Counter instance</DL> +</DD> +</DL> +<HR> + +<A NAME="newCounter(java.lang.String, org.apache.samza.metrics.Counter)"><!-- --></A><H3> +newCounter</H3> +<PRE> +<A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A> <B>newCounter</B>(java.lang.String group, + <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</A> counter)</PRE> +<DL> +<DD>Register existing <A HREF="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><CODE>Counter</CODE></A> with this registry +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>group</CODE> - Group for this Counter<DD><CODE>counter</CODE> - Existing Counter to register +<DT><B>Returns:</B><DD>Counter that was registered</DL> +</DD> +</DL> +<HR> + +<A NAME="newGauge(java.lang.String,java.lang.String,java.lang.Object)"><!-- --></A><A NAME="newGauge(java.lang.String, java.lang.String, T)"><!-- --></A><H3> +newGauge</H3> +<PRE> +<T> <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A><T> <B>newGauge</B>(java.lang.String group, + java.lang.String name, + T value)</PRE> +<DL> +<DD>Create and register a new <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><CODE>Gauge</CODE></A> +<P> +<DD><DL> +<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - Type the Gauge will be wrapping<DT><B>Parameters:</B><DD><CODE>group</CODE> - Group for this Gauge<DD><CODE>name</CODE> - Name of to-be-created Gauge<DD><CODE>value</CODE> - Initial value for the Gauge +<DT><B>Returns:</B><DD>Gauge was created and registered</DL> +</DD> +</DL> +<HR> + +<A NAME="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)"><!-- --></A><H3> +newGauge</H3> +<PRE> +<T> <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A><T> <B>newGauge</B>(java.lang.String group, + <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</A><T> value)</PRE> +<DL> +<DD>Register an existing <A HREF="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><CODE>Gauge</CODE></A> +<P> +<DD><DL> +<DT><B>Type Parameters:</B><DD><CODE>T</CODE> - Type the Gauge will be wrapping<DT><B>Parameters:</B><DD><CODE>group</CODE> - Group for this Gauge<DD><CODE>value</CODE> - Initial value for the Gauge +<DT><B>Returns:</B><DD>Gauge was registered</DL> +</DD> +</DL> +<HR> + +<A NAME="newTimer(java.lang.String, java.lang.String)"><!-- --></A><H3> +newTimer</H3> +<PRE> +<A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A> <B>newTimer</B>(java.lang.String group, + java.lang.String name)</PRE> +<DL> +<DD>Create and Register a new <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><CODE>Timer</CODE></A> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>group</CODE> - Group for this Timer<DD><CODE>name</CODE> - Name of to-be-created Timer +<DT><B>Returns:</B><DD>New Timer instance</DL> +</DD> +</DL> +<HR> + +<A NAME="newTimer(java.lang.String, org.apache.samza.metrics.Timer)"><!-- --></A><H3> +newTimer</H3> +<PRE> +<A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A> <B>newTimer</B>(java.lang.String group, + <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</A> timer)</PRE> +<DL> +<DD>Register existing <A HREF="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><CODE>Timer</CODE></A> with this registry +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>group</CODE> - Group for this Timer<DD><CODE>timer</CODE> - Existing Timer to register +<DT><B>Returns:</B><DD>Timer that was registered</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/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface 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/MetricsRegistry.html" target="_top">Frames</a></li> -<li><a href="MetricsRegistry.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/Metric.html" title="interface in org.apache.samza.metrics"><B>PREV CLASS</B></A> + <A HREF="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface 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/MetricsRegistry.html" target="_top"><B>FRAMES</B></A> + <A HREF="MetricsRegistry.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>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> +</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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <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>
