blob: ac5b69d6ada39c90c9a4fd8079364a807304d133 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:06 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CacheStatisticsSPI (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="CacheStatisticsSPI (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/CacheStatisticsSPI.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">
<li><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsImpl.html" title="class in org.apache.openjpa.datacache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/datacache/ClearableScheduler.html" title="class in org.apache.openjpa.datacache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/datacache/CacheStatisticsSPI.html" target="_top">Frames</a></li>
<li><a href="CacheStatisticsSPI.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">org.apache.openjpa.datacache</div>
<h2 title="Interface CacheStatisticsSPI" class="title">Interface CacheStatisticsSPI</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsImpl.html" title="class in org.apache.openjpa.datacache">CacheStatisticsImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CacheStatisticsSPI</span>
extends <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a></pre>
<div class="block">The provider extensions to the CacheStatistics interface.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html#disable--">disable</a></span>()</code>
<div class="block">Disable statistics collection.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html#enable--">enable</a></span>()</code>
<div class="block">Enable statistics collection.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html#newGet-java.lang.Class-boolean-">newGet</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls,
boolean&nbsp;hit)</code>
<div class="block">Record a new cache get.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html#newPut-java.lang.Class-">newPut</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</code>
<div class="block">Record a new cache put.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.datacache.CacheStatistics">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#classNames--">classNames</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getHitCount--">getHitCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getHitCount-java.lang.Class-">getHitCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getHitCount-java.lang.String-">getHitCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getReadCount--">getReadCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getReadCount-java.lang.Class-">getReadCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getReadCount-java.lang.String-">getReadCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalHitCount--">getTotalHitCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalHitCount-java.lang.Class-">getTotalHitCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalHitCount-java.lang.String-">getTotalHitCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalReadCount--">getTotalReadCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalReadCount-java.lang.Class-">getTotalReadCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalReadCount-java.lang.String-">getTotalReadCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalWriteCount--">getTotalWriteCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalWriteCount-java.lang.Class-">getTotalWriteCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getTotalWriteCount-java.lang.String-">getTotalWriteCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getWriteCount--">getWriteCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getWriteCount-java.lang.Class-">getWriteCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#getWriteCount-java.lang.String-">getWriteCount</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#isEnabled--">isEnabled</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#reset--">reset</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#since--">since</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#start--">start</a>, <a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html#toMap--">toMap</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="newGet-java.lang.Class-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newGet</h4>
<pre>void&nbsp;newGet(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls,
boolean&nbsp;hit)</pre>
<div class="block">Record a new cache get.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - - The class describing the type that is contained in the cache.</dd>
<dd><code>hit</code> - - true for a cache hit, false otherwise</dd>
</dl>
</li>
</ul>
<a name="newPut-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newPut</h4>
<pre>void&nbsp;newPut(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;cls)</pre>
<div class="block">Record a new cache put.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - - The class describing the type that is contained in the cache.</dd>
</dl>
</li>
</ul>
<a name="enable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre>void&nbsp;enable()</pre>
<div class="block">Enable statistics collection.</div>
</li>
</ul>
<a name="disable--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>disable</h4>
<pre>void&nbsp;disable()</pre>
<div class="block">Disable statistics collection.</div>
</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="class-use/CacheStatisticsSPI.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">
<li><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsImpl.html" title="class in org.apache.openjpa.datacache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/datacache/ClearableScheduler.html" title="class in org.apache.openjpa.datacache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/datacache/CacheStatisticsSPI.html" target="_top">Frames</a></li>
<li><a href="CacheStatisticsSPI.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>