blob: a22b806ba1f911c5632dfd2db85cbfc9fe8b5b3c [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:50 PDT 2017 -->
<title>ContextAwareReporter (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="ContextAwareReporter (gobblin-metrics-base 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/reporter/ConfiguredScheduledReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/metrics/reporter/ContextAwareScheduledReporter.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/metrics/reporter/ContextAwareReporter.html" target="_top">Frames</a></li>
<li><a href="ContextAwareReporter.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.reporter</div>
<h2 title="Class ContextAwareReporter" class="title">Class ContextAwareReporter</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>gobblin.metrics.reporter.ContextAwareReporter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.codahale.metrics.Reporter, <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html" title="class in gobblin.metrics.reporter">ScheduledReporter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ContextAwareReporter</span>
extends <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>
implements com.codahale.metrics.Reporter, <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre>
<div class="block">Base <code>Reporter</code> for gobblin metrics. Automatically handles <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> selection,
<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a> filtering, and changes to reporting on <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> life cycle.
<p>
The lifecycle of a <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> fully managed by the <a href="../../../gobblin/metrics/RootMetricContext.html" title="class in gobblin.metrics"><code>RootMetricContext</code></a> is:
<code>construct -&gt; start -&gt; stop -&gt; close</code>. However, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>s created manually by the user
can have a different life cycle (for example multiple calls to start / stop).
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#config">config</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#name">name</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#ContextAwareReporter-java.lang.String-com.typesafe.config.Config-">ContextAwareReporter</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;config)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#close--">close</a></span>()</code>
<div class="block">Removes <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> records from the <a href="../../../gobblin/metrics/RootMetricContext.html" title="class in gobblin.metrics"><code>RootMetricContext</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../gobblin/metrics/context/ReportableContext.html" title="interface in gobblin.metrics.context">ReportableContext</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#getMetricContextsToReport--">getMetricContextsToReport</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#isStarted--">isStarted</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#newMetricContext-gobblin.metrics.MetricContext-">newMetricContext</a></span>(<a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics">MetricContext</a>&nbsp;context)</code>
<div class="block">Called whenever a new <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> is added to the tree.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#removedMetricContext-gobblin.metrics.InnerMetricContext-">removedMetricContext</a></span>(<a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics">InnerMetricContext</a>&nbsp;context)</code>
<div class="block">Called when any <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> is removed from the tree.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#shouldReportInnerMetricContext-gobblin.metrics.InnerMetricContext-">shouldReportInnerMetricContext</a></span>(<a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics">InnerMetricContext</a>&nbsp;context)</code>
<div class="block">Whether a <a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics"><code>InnerMetricContext</code></a> should be reported.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#start--">start</a></span>()</code>
<div class="block">Starts the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#startImpl--">startImpl</a></span>()</code>
<div class="block">Actual logic for starting the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#stop--">stop</a></span>()</code>
<div class="block">Stops the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#stopImpl--">stopImpl</a></span>()</code>
<div class="block">Actual logic for stopping the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>.</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&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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre>
</li>
</ul>
<a name="config">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>config</h4>
<pre>protected final&nbsp;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a> config</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ContextAwareReporter-java.lang.String-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ContextAwareReporter</h4>
<pre>public&nbsp;ContextAwareReporter(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;config)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isStarted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStarted</h4>
<pre>public&nbsp;boolean&nbsp;isStarted()</pre>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public final&nbsp;void&nbsp;start()</pre>
<div class="block">Starts the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>. If the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> has been started
(and not stopped since), this is a no-op.</div>
</li>
</ul>
<a name="startImpl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startImpl</h4>
<pre>protected&nbsp;void&nbsp;startImpl()</pre>
<div class="block">Actual logic for starting the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>. This is a separate method from <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#start--"><code>start()</code></a> to
allow <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> to handle the started / non-started state.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public final&nbsp;void&nbsp;stop()</pre>
<div class="block">Stops the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>. If the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> has not been started, or if it has been
stopped already, and not started since, this is a no-op.</div>
</li>
</ul>
<a name="stopImpl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopImpl</h4>
<pre>protected&nbsp;void&nbsp;stopImpl()</pre>
<div class="block">Actual logic for stopping the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>. This is a separate method from <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#stop--"><code>stop()</code></a> to
allow <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> to handle the started / non-started state.</div>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Removes <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a> records from the <a href="../../../gobblin/metrics/RootMetricContext.html" title="class in gobblin.metrics"><code>RootMetricContext</code></a>.
This method should be considered irreversible and destructive to the <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter"><code>ContextAwareReporter</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="removedMetricContext-gobblin.metrics.InnerMetricContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removedMetricContext</h4>
<pre>protected&nbsp;void&nbsp;removedMetricContext(<a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics">InnerMetricContext</a>&nbsp;context)</pre>
<div class="block">Called when any <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> is removed from the tree.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - <a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics"><code>InnerMetricContext</code></a> backing the removed <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a>.</dd>
</dl>
</li>
</ul>
<a name="newMetricContext-gobblin.metrics.MetricContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newMetricContext</h4>
<pre>protected&nbsp;void&nbsp;newMetricContext(<a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics">MetricContext</a>&nbsp;context)</pre>
<div class="block">Called whenever a new <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> is added to the tree.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - new <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> added.</dd>
</dl>
</li>
</ul>
<a name="shouldReportInnerMetricContext-gobblin.metrics.InnerMetricContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldReportInnerMetricContext</h4>
<pre>protected&nbsp;boolean&nbsp;shouldReportInnerMetricContext(<a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics">InnerMetricContext</a>&nbsp;context)</pre>
<div class="block">Whether a <a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics"><code>InnerMetricContext</code></a> should be reported. Called when a <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> has been removed and
just before the corresponding <a href="../../../gobblin/metrics/InnerMetricContext.html" title="class in gobblin.metrics"><code>InnerMetricContext</code></a> is removed.</div>
</li>
</ul>
<a name="getMetricContextsToReport--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMetricContextsToReport</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../gobblin/metrics/context/ReportableContext.html" title="interface in gobblin.metrics.context">ReportableContext</a>&gt;&nbsp;getMetricContextsToReport()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of all <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a>s to report.</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/reporter/ConfiguredScheduledReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/metrics/reporter/ContextAwareScheduledReporter.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/metrics/reporter/ContextAwareReporter.html" target="_top">Frames</a></li>
<li><a href="ContextAwareReporter.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>