blob: c8c7ac92371c24949a873d78a6fb6abc404fcad7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>NoopMetricsSystem (Apache Calcite Avatica API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NoopMetricsSystem (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NoopMetricsSystem.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.avatica.metrics.noop</a></div>
<h2 title="Class NoopMetricsSystem" class="title">Class NoopMetricsSystem</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.avatica.metrics.noop.NoopMetricsSystem</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">NoopMetricsSystem</span>
extends java.lang.Object
implements <a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></pre>
<div class="block"><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a> implementation which does nothing. Returns <a href="../Metric.html" title="interface in org.apache.calcite.avatica.metrics"><code>Metric</code></a> implementations
which also does nothing (avoiding null instances).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../Counter.html" title="interface in org.apache.calcite.avatica.metrics">Counter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCounter(java.lang.String)">getCounter</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get or construct a <a href="../Counter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Counter</code></a> used to track a mutable number.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics">Histogram</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHistogram(java.lang.String)">getHistogram</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get or construct a <a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a> used to measure a distribution of values.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="NoopMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.noop">NoopMetricsSystem</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../Meter.html" title="interface in org.apache.calcite.avatica.metrics">Meter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMeter(java.lang.String)">getMeter</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get or construct a <a href="../Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a> used to measure durations and report distributions (a
combination of a <a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> and a <a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics">Timer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimer(java.lang.String)">getTimer</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Get or construct a <a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> used to measure durations and report rates.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(java.lang.String,org.apache.calcite.avatica.metrics.Gauge)">register</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../Gauge.html" title="interface in org.apache.calcite.avatica.metrics">Gauge</a>&lt;T&gt;&nbsp;gauge)</code></th>
<td class="colLast">
<div class="block">Register a <a href="../Gauge.html" title="interface in org.apache.calcite.avatica.metrics"><code>Gauge</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="NoopMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.noop">NoopMetricsSystem</a>&nbsp;getInstance()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="NoopMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.noop"><code>NoopMetricsSystem</code></a> instance.</dd>
</dl>
</li>
</ul>
<a id="getTimer(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimer</h4>
<pre class="methodSignature">public&nbsp;<a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics">Timer</a>&nbsp;getTimer&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../MetricsSystem.html#getTimer(java.lang.String)">MetricsSystem</a></code></span></div>
<div class="block">Get or construct a <a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> used to measure durations and report rates.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MetricsSystem.html#getTimer(java.lang.String)">getTimer</a></code>&nbsp;in interface&nbsp;<code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Timer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a>.</dd>
</dl>
</li>
</ul>
<a id="getHistogram(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHistogram</h4>
<pre class="methodSignature">public&nbsp;<a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics">Histogram</a>&nbsp;getHistogram&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../MetricsSystem.html#getHistogram(java.lang.String)">MetricsSystem</a></code></span></div>
<div class="block">Get or construct a <a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a> used to measure a distribution of values.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MetricsSystem.html#getHistogram(java.lang.String)">getHistogram</a></code>&nbsp;in interface&nbsp;<code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Histogram.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a>.</dd>
</dl>
</li>
</ul>
<a id="getMeter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMeter</h4>
<pre class="methodSignature">public&nbsp;<a href="../Meter.html" title="interface in org.apache.calcite.avatica.metrics">Meter</a>&nbsp;getMeter&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../MetricsSystem.html#getMeter(java.lang.String)">MetricsSystem</a></code></span></div>
<div class="block">Get or construct a <a href="../Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a> used to measure durations and report distributions (a
combination of a <a href="../Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> and a <a href="../Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MetricsSystem.html#getMeter(java.lang.String)">getMeter</a></code>&nbsp;in interface&nbsp;<code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Meter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a>.</dd>
</dl>
</li>
</ul>
<a id="getCounter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCounter</h4>
<pre class="methodSignature">public&nbsp;<a href="../Counter.html" title="interface in org.apache.calcite.avatica.metrics">Counter</a>&nbsp;getCounter&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../MetricsSystem.html#getCounter(java.lang.String)">MetricsSystem</a></code></span></div>
<div class="block">Get or construct a <a href="../Counter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Counter</code></a> used to track a mutable number.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MetricsSystem.html#getCounter(java.lang.String)">getCounter</a></code>&nbsp;in interface&nbsp;<code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Counter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../Counter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Counter</code></a>.</dd>
</dl>
</li>
</ul>
<a id="register(java.lang.String,org.apache.calcite.avatica.metrics.Gauge)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;void&nbsp;register&#8203;(java.lang.String&nbsp;name,
<a href="../Gauge.html" title="interface in org.apache.calcite.avatica.metrics">Gauge</a>&lt;T&gt;&nbsp;gauge)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../MetricsSystem.html#register(java.lang.String,org.apache.calcite.avatica.metrics.Gauge)">MetricsSystem</a></code></span></div>
<div class="block">Register a <a href="../Gauge.html" title="interface in org.apache.calcite.avatica.metrics"><code>Gauge</code></a>. The Gauge will be invoked at a period defined by the implementation
of <a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../MetricsSystem.html#register(java.lang.String,org.apache.calcite.avatica.metrics.Gauge)">register</a></code>&nbsp;in interface&nbsp;<code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Gauge.</dd>
<dd><code>gauge</code> - A callback to compute the current value.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NoopMetricsSystem.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>