blob: b6f7f34b2aec4f63d714f49616d586c84aadf976 [file] [log] [blame]
<!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 (1.8.0_40) on Thu Jul 20 13:15:49 PDT 2017 -->
<title>ContextAwareMeter (gobblin-metrics-base 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ContextAwareMeter (gobblin-metrics-base 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<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="../../gobblin/metrics/ContextAwareGauge.html" title="class in gobblin.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/metrics/ContextAwareMetric.html" title="interface in gobblin.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/metrics/ContextAwareMeter.html" target="_top">Frames</a></li>
<li><a href="ContextAwareMeter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">gobblin.metrics</div>
<h2 title="Class ContextAwareMeter" class="title">Class ContextAwareMeter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.codahale.metrics.Meter</li>
<li>
<ul class="inheritance">
<li>gobblin.metrics.ContextAwareMeter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.codahale.metrics.Counting, com.codahale.metrics.Metered, com.codahale.metrics.Metric, <a href="../../gobblin/metrics/ContextAwareMetric.html" title="interface in gobblin.metrics">ContextAwareMetric</a>, <a href="../../gobblin/metrics/metric/ProxyMetric.html" title="interface in gobblin.metrics.metric">ProxyMetric</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ContextAwareMeter</span>
extends com.codahale.metrics.Meter
implements <a href="../../gobblin/metrics/ContextAwareMetric.html" title="interface in gobblin.metrics">ContextAwareMetric</a></pre>
<div class="block">A type of <code>Meter</code>s that are aware of their <a href="../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a>
and can have associated <a href="../../gobblin/metrics/Tag.html" title="class in gobblin.metrics"><code>Tag</code></a>s.
<p>
Any updates to a <a href="../../gobblin/metrics/ContextAwareMeter.html" title="class in gobblin.metrics"><code>ContextAwareMeter</code></a> will be applied automatically to the
<a href="../../gobblin/metrics/ContextAwareMeter.html" title="class in gobblin.metrics"><code>ContextAwareMeter</code></a> of the same name in the parent <a href="../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a>.
</p>
<p>
This class wraps a <code>Meter</code> and delegates calls to public methods of
<code>Meter</code> to the wrapped <code>Meter</code>.
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics">MetricContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/metrics/ContextAwareMeter.html#getContext--">getContext</a></span>()</code>
<div class="block">Get the <a href="../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> the metric is registered in.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../gobblin/metrics/metric/InnerMetric.html" title="interface in gobblin.metrics.metric">InnerMetric</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/metrics/ContextAwareMeter.html#getInnerMetric--">getInnerMetric</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.codahale.metrics.Meter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.codahale.metrics.Meter</h3>
<code>getCount, getFifteenMinuteRate, getFiveMinuteRate, getMeanRate, getOneMinuteRate, mark, mark</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.metrics.ContextAwareMetric">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;gobblin.metrics.<a href="../../gobblin/metrics/ContextAwareMetric.html" title="interface in gobblin.metrics">ContextAwareMetric</a></h3>
<code><a href="../../gobblin/metrics/ContextAwareMetric.html#getName--">getName</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre>public&nbsp;<a href="../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics">MetricContext</a>&nbsp;getContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../gobblin/metrics/ContextAwareMetric.html#getContext--">ContextAwareMetric</a></code></span></div>
<div class="block">Get the <a href="../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> the metric is registered in.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../gobblin/metrics/ContextAwareMetric.html#getContext--">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../gobblin/metrics/ContextAwareMetric.html" title="interface in gobblin.metrics">ContextAwareMetric</a></code></dd>
</dl>
</li>
</ul>
<a name="getInnerMetric--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInnerMetric</h4>
<pre>public&nbsp;<a href="../../gobblin/metrics/metric/InnerMetric.html" title="interface in gobblin.metrics.metric">InnerMetric</a>&nbsp;getInnerMetric()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../gobblin/metrics/metric/ProxyMetric.html#getInnerMetric--">getInnerMetric</a></code>&nbsp;in interface&nbsp;<code><a href="../../gobblin/metrics/metric/ProxyMetric.html" title="interface in gobblin.metrics.metric">ProxyMetric</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>associated <a href="../../gobblin/metrics/metric/InnerMetric.html" title="interface in gobblin.metrics.metric"><code>InnerMetric</code></a>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<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="../../gobblin/metrics/ContextAwareGauge.html" title="class in gobblin.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../gobblin/metrics/ContextAwareMetric.html" title="interface in gobblin.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/metrics/ContextAwareMeter.html" target="_top">Frames</a></li>
<li><a href="ContextAwareMeter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>