blob: 5eab6a7526e2ccebb6e116b925d2735e82fe05d2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MeasurableStat (kafka 2.8.1 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="MeasurableStat (kafka 2.8.1 API)";
}
}
catch(err) {
}
//-->
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="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>Method</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.kafka.common.metrics</a></div>
<h2 title="Interface MeasurableStat" class="title">Interface MeasurableStat</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="Measurable.html" title="interface in org.apache.kafka.common.metrics">Measurable</a></code>, <code><a href="MetricValueProvider.html" title="interface in org.apache.kafka.common.metrics">MetricValueProvider</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a>&gt;</code>, <code><a href="Stat.html" title="interface in org.apache.kafka.common.metrics">Stat</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="stats/Avg.html" title="class in org.apache.kafka.common.metrics.stats">Avg</a></code>, <code><a href="stats/Count.html" title="class in org.apache.kafka.common.metrics.stats">Count</a></code>, <code><a href="stats/CumulativeCount.html" title="class in org.apache.kafka.common.metrics.stats">CumulativeCount</a></code>, <code><a href="stats/CumulativeSum.html" title="class in org.apache.kafka.common.metrics.stats">CumulativeSum</a></code>, <code><a href="stats/Frequencies.html" title="class in org.apache.kafka.common.metrics.stats">Frequencies</a></code>, <code><a href="stats/Max.html" title="class in org.apache.kafka.common.metrics.stats">Max</a></code>, <code><a href="stats/Min.html" title="class in org.apache.kafka.common.metrics.stats">Min</a></code>, <code><a href="stats/Percentiles.html" title="class in org.apache.kafka.common.metrics.stats">Percentiles</a></code>, <code><a href="stats/Rate.html" title="class in org.apache.kafka.common.metrics.stats">Rate</a></code>, <code><a href="stats/Rate.SampledTotal.html" title="class in org.apache.kafka.common.metrics.stats">Rate.SampledTotal</a></code>, <code><a href="stats/SampledStat.html" title="class in org.apache.kafka.common.metrics.stats">SampledStat</a></code>, <code><a href="stats/SimpleRate.html" title="class in org.apache.kafka.common.metrics.stats">SimpleRate</a></code>, <code><a href="stats/Sum.html" title="class in org.apache.kafka.common.metrics.stats">Sum</a></code>, <code><a href="stats/TokenBucket.html" title="class in org.apache.kafka.common.metrics.stats">TokenBucket</a></code>, <code><a href="stats/Total.html" title="class in org.apache.kafka.common.metrics.stats">Total</a></code>, <code><a href="stats/Value.html" title="class in org.apache.kafka.common.metrics.stats">Value</a></code>, <code><a href="stats/WindowedCount.html" title="class in org.apache.kafka.common.metrics.stats">WindowedCount</a></code>, <code><a href="stats/WindowedSum.html" title="class in org.apache.kafka.common.metrics.stats">WindowedSum</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">MeasurableStat</span>
extends <a href="Stat.html" title="interface in org.apache.kafka.common.metrics">Stat</a>, <a href="Measurable.html" title="interface in org.apache.kafka.common.metrics">Measurable</a></pre>
<div class="block">A MeasurableStat is a <a href="Stat.html" title="interface in org.apache.kafka.common.metrics"><code>Stat</code></a> that is also <a href="Measurable.html" title="interface in org.apache.kafka.common.metrics"><code>Measurable</code></a> (i.e. can produce a single floating point value).
This is the interface used for most of the simple statistics such as <a href="stats/Avg.html" title="class in org.apache.kafka.common.metrics.stats"><code>Avg</code></a>,
<a href="stats/Max.html" title="class in org.apache.kafka.common.metrics.stats"><code>Max</code></a>, <a href="stats/CumulativeCount.html" title="class in org.apache.kafka.common.metrics.stats"><code>CumulativeCount</code></a>, etc.</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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.kafka.common.metrics.Measurable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.kafka.common.metrics.<a href="Measurable.html" title="interface in org.apache.kafka.common.metrics">Measurable</a></h3>
<code><a href="Measurable.html#measure(org.apache.kafka.common.metrics.MetricConfig,long)">measure</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.kafka.common.metrics.Stat">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.kafka.common.metrics.<a href="Stat.html" title="interface in org.apache.kafka.common.metrics">Stat</a></h3>
<code><a href="Stat.html#record(org.apache.kafka.common.metrics.MetricConfig,double,long)">record</a></code></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="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>Method</li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>