http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheLoaderException.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheLoaderException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheLoaderException.html new file mode 100644 index 0000000..8f47520 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheLoaderException.html @@ -0,0 +1,366 @@ +<!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_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>CacheLoaderException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="CacheLoaderException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +</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="../../../../com/gemstone/gemfire/cache/CacheLoader.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheLoaderException.html" target="_top">Frames</a></li> +<li><a href="CacheLoaderException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire.cache</div> +<h2 title="Class CacheLoaderException" class="title">Class CacheLoaderException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.CacheRuntimeException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/gemstone/gemfire/cache/OperationAbortedException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.OperationAbortedException</a></li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.CacheLoaderException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CacheLoaderException</span> +extends <a href="../../../../com/gemstone/gemfire/cache/OperationAbortedException.html" title="class in com.gemstone.gemfire.cache">OperationAbortedException</a></pre> +<div class="block">Thrown from the <a href="../../../../com/gemstone/gemfire/cache/CacheLoader.html#load-com.gemstone.gemfire.cache.LoaderHelper-"><code>CacheLoader.load(com.gemstone.gemfire.cache.LoaderHelper<K, V>)</code></a> method indicating that an error + occurred when a CacheLoader was attempting to load a value. This + exception is propagated back to the caller of <code>Region.get</code>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/CacheLoader.html#load-com.gemstone.gemfire.cache.LoaderHelper-"><code>CacheLoader.load(com.gemstone.gemfire.cache.LoaderHelper<K, V>)</code></a>, +<a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.CacheLoaderException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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"> </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="../../../../com/gemstone/gemfire/cache/CacheLoaderException.html#CacheLoaderException--">CacheLoaderException</a></span>()</code> +<div class="block">Creates a new instance of <code>CacheLoaderException</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheLoaderException.html#CacheLoaderException-java.lang.String-">CacheLoaderException</a></span>(java.lang.String msg)</code> +<div class="block">Constructs an instance of <code>CacheLoaderException</code> with the specified detail message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheLoaderException.html#CacheLoaderException-java.lang.String-java.lang.Throwable-">CacheLoaderException</a></span>(java.lang.String msg, + java.lang.Throwable cause)</code> +<div class="block">Constructs an instance of <code>CacheLoaderException</code> with the specified detail message + and cause.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheLoaderException.html#CacheLoaderException-java.lang.Throwable-">CacheLoaderException</a></span>(java.lang.Throwable cause)</code> +<div class="block">Constructs an instance of <code>CacheLoaderException</code> with the specified cause.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.cache.<a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache">CacheRuntimeException</a></h3> +<code><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> +<code><a href="../../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CacheLoaderException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException()</pre> +<div class="block">Creates a new instance of <code>CacheLoaderException</code>.</div> +</li> +</ul> +<a name="CacheLoaderException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException(java.lang.String msg)</pre> +<div class="block">Constructs an instance of <code>CacheLoaderException</code> with the specified detail message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msg</code> - the detail message</dd> +</dl> +</li> +</ul> +<a name="CacheLoaderException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException(java.lang.String msg, + java.lang.Throwable cause)</pre> +<div class="block">Constructs an instance of <code>CacheLoaderException</code> with the specified detail message + and cause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msg</code> - the detail message</dd> +<dd><code>cause</code> - the causal Throwable</dd> +</dl> +</li> +</ul> +<a name="CacheLoaderException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CacheLoaderException</h4> +<pre>public CacheLoaderException(java.lang.Throwable cause)</pre> +<div class="block">Constructs an instance of <code>CacheLoaderException</code> with the specified cause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cause</code> - the causal Throwable</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="../../../../com/gemstone/gemfire/cache/CacheLoader.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheLoaderException.html" target="_top">Frames</a></li> +<li><a href="CacheLoaderException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.com.gemstone.gemfire.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheRuntimeException.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheRuntimeException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheRuntimeException.html new file mode 100644 index 0000000..f23096e --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheRuntimeException.html @@ -0,0 +1,390 @@ +<!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_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>CacheRuntimeException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="CacheRuntimeException (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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="../../../../com/gemstone/gemfire/cache/CacheLoaderException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheRuntimeException.html" target="_top">Frames</a></li> +<li><a href="CacheRuntimeException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">com.gemstone.gemfire.cache</div> +<h2 title="Class CacheRuntimeException" class="title">Class CacheRuntimeException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.CacheRuntimeException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheXmlException.html" title="class in com.gemstone.gemfire.cache">CacheXmlException</a>, <a href="../../../../com/gemstone/gemfire/CancelException.html" title="class in com.gemstone.gemfire">CancelException</a>, <a href="../../../../com/gemstone/gemfire/cache/query/CqClosedException.html" title="class in com.gemstone.gemfire.cache.query">CqClosedException</a>, <a href="../../../../com/gemstone/gemfire/cache/DiskAccessException.html" title="class in com.gemstone.gemfire.cache">DiskAccessException</a>, <a href="../../../../com/gemstone/gemfire/cache/EntryDestroyedException.html" title="class in com.gemstone.gemfire.cache">EntryDestroyedException</a>, <a href="../../../../com/gemstone/gemfire/cache/FailedSynchronizationException.html" title="class in com.gemstone.gemfire.cache">FailedSynchronizationException</a>, <a href="../../../../com/gemstone/gemfire/cache/query/IndexMaintenanceException.html" title="class in com.gemstone.gemfir e.cache.query">IndexMaintenanceException</a>, <a href="../../../../com/gemstone/gemfire/cache/OperationAbortedException.html" title="class in com.gemstone.gemfire.cache">OperationAbortedException</a>, <a href="../../../../com/gemstone/gemfire/cache/PartitionedRegionDistributionException.html" title="class in com.gemstone.gemfire.cache">PartitionedRegionDistributionException</a>, <a href="../../../../com/gemstone/gemfire/cache/PartitionedRegionStorageException.html" title="class in com.gemstone.gemfire.cache">PartitionedRegionStorageException</a>, <a href="../../../../com/gemstone/gemfire/cache/query/QueryExecutionLowMemoryException.html" title="class in com.gemstone.gemfire.cache.query">QueryExecutionLowMemoryException</a>, <a href="../../../../com/gemstone/gemfire/cache/query/QueryExecutionTimeoutException.html" title="class in com.gemstone.gemfire.cache.query">QueryExecutionTimeoutException</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionDestroyedException.html" title=" class in com.gemstone.gemfire.cache">RegionDestroyedException</a>, <a href="../../../../com/gemstone/gemfire/admin/RegionNotFoundException.html" title="class in com.gemstone.gemfire.admin">RegionNotFoundException</a>, <a href="../../../../com/gemstone/gemfire/cache/ResourceException.html" title="class in com.gemstone.gemfire.cache">ResourceException</a>, <a href="../../../../com/gemstone/gemfire/cache/RoleException.html" title="class in com.gemstone.gemfire.cache">RoleException</a>, <a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a>, <a href="../../../../com/gemstone/gemfire/cache/SynchronizationCommitConflictException.html" title="class in com.gemstone.gemfire.cache">SynchronizationCommitConflictException</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">CacheRuntimeException</span> +extends <a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></pre> +<div class="block">A generic runtime exception that indicates + a cache error has occurred. All the other runtime cache exceptions are the + subclass of this class. This class is abstract so only subclasses can be + instantiated</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.CacheRuntimeException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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"> </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="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#CacheRuntimeException--">CacheRuntimeException</a></span>()</code> +<div class="block">Creates a new instance of <code>CacheRuntimeException</code> without detail message.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#CacheRuntimeException-java.lang.String-">CacheRuntimeException</a></span>(java.lang.String msg)</code> +<div class="block">Constructs an instance of <code>CacheRuntimeException</code> with the specified detail message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#CacheRuntimeException-java.lang.String-java.lang.Throwable-">CacheRuntimeException</a></span>(java.lang.String msg, + java.lang.Throwable cause)</code> +<div class="block">Constructs an instance of <code>CacheRuntimeException</code> with the specified detail message + and cause.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#CacheRuntimeException-java.lang.Throwable-">CacheRuntimeException</a></span>(java.lang.Throwable cause)</code> +<div class="block">Constructs an instance of <code>CacheRuntimeException</code> with the specified cause.</div> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../../com/gemstone/gemfire/GemFireException.html" title="class in com.gemstone.gemfire">GemFireException</a></h3> +<code><a href="../../../../com/gemstone/gemfire/GemFireException.html#getRootCause--">getRootCause</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CacheRuntimeException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheRuntimeException</h4> +<pre>public CacheRuntimeException()</pre> +<div class="block">Creates a new instance of <code>CacheRuntimeException</code> without detail message.</div> +</li> +</ul> +<a name="CacheRuntimeException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheRuntimeException</h4> +<pre>public CacheRuntimeException(java.lang.String msg)</pre> +<div class="block">Constructs an instance of <code>CacheRuntimeException</code> with the specified detail message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msg</code> - the detail message</dd> +</dl> +</li> +</ul> +<a name="CacheRuntimeException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CacheRuntimeException</h4> +<pre>public CacheRuntimeException(java.lang.String msg, + java.lang.Throwable cause)</pre> +<div class="block">Constructs an instance of <code>CacheRuntimeException</code> with the specified detail message + and cause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msg</code> - the detail message</dd> +<dd><code>cause</code> - the causal Throwable</dd> +</dl> +</li> +</ul> +<a name="CacheRuntimeException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CacheRuntimeException</h4> +<pre>public CacheRuntimeException(java.lang.Throwable cause)</pre> +<div class="block">Constructs an instance of <code>CacheRuntimeException</code> with the specified cause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cause</code> - the causal Throwable</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Throwable</code></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="../../../../com/gemstone/gemfire/cache/CacheLoaderException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheRuntimeException.html" target="_top">Frames</a></li> +<li><a href="CacheRuntimeException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheStatistics.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheStatistics.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheStatistics.html new file mode 100644 index 0000000..8c61e6f --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CacheStatistics.html @@ -0,0 +1,411 @@ +<!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_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>CacheStatistics (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="CacheStatistics (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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="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="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheStatistics.html" target="_top">Frames</a></li> +<li><a href="CacheStatistics.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.gemstone.gemfire.cache</div> +<h2 title="Interface CacheStatistics" class="title">Interface CacheStatistics</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">CacheStatistics</span></pre> +<div class="block">Defines common statistics information + for both region and entries. All of these methods may throw a + CacheClosedException, RegionDestroyedException or an EntryDestroyedException.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#getStatistics--"><code>Region.getStatistics()</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/Region.Entry.html#getStatistics--"><code>Region.Entry.getStatistics()</code></a></dd> +</dl> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getHitCount--">getHitCount</a></span>()</code> +<div class="block">Returns the number of hits for this region or entry.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getHitRatio--">getHitRatio</a></span>()</code> +<div class="block">Return the hit ratio, a convenience method defined as the ratio of hits + to the number of calls to <a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastAccessedTime--">getLastAccessedTime</a></span>()</code> +<div class="block">For an entry, returns the last time it was accessed via <code>Region.get</code>; + for a region, the last time any of its entries or the entries of its + subregions were accessed with <code>Region.get</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastModifiedTime--">getLastModifiedTime</a></span>()</code> +<div class="block">For an entry, returns the time that the entry's value was last modified; + for a region, the last time any of the region's entries' values or the + values in subregions' entries were modified.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getMissCount--">getMissCount</a></span>()</code> +<div class="block">Returns the number of times that <a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get</code></a> on + the region or the entry was called and there was no value found + locally.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#resetCounts--">resetCounts</a></span>()</code> +<div class="block">Reset the missCount and hitCount to zero for this entry.</div> +</td> +</tr> +</table> +</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="getLastModifiedTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastModifiedTime</h4> +<pre>long getLastModifiedTime()</pre> +<div class="block">For an entry, returns the time that the entry's value was last modified; + for a region, the last time any of the region's entries' values or the + values in subregions' entries were modified. The + modification may have been initiated locally or it may have been an update + distributed from another cache. It may also have been a new value provided + by a loader. The modification time on a region is propagated upward to parent + regions, transitively, to the root region. + <p> + The number is expressed as the number of milliseconds since January 1, 1970. + The granularity may be as course as 100ms, so the accuracy may be off by + up to 50ms. + <p> + Entry and subregion creation will update the modification time on a + region, but <code>destroy</code>, <code>destroyRegion</code>, + <code>invalidate</code>, and <code>invalidateRegion</code> + do not update the modification time.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the last modification time of the region or the entry; + returns 0 if entry is invalid or modification time is uninitialized.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/Region.html#createSubregion-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-"><code>Region.createSubregion(java.lang.String, com.gemstone.gemfire.cache.RegionAttributes<SK, SV>)</code></a></dd> +</dl> +</li> +</ul> +<a name="getLastAccessedTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastAccessedTime</h4> +<pre>long getLastAccessedTime() + throws <a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></pre> +<div class="block">For an entry, returns the last time it was accessed via <code>Region.get</code>; + for a region, the last time any of its entries or the entries of its + subregions were accessed with <code>Region.get</code>. + Any modifications will also update the lastAccessedTime, so + <code>lastAccessedTime</code> is always <code>>= lastModifiedTime</code>. + The <code>lastAccessedTime</code> on a region is propagated upward to + parent regions, transitively, to the the root region. + <p> + The number is expressed as the number of milliseconds + since January 1, 1970. + The granularity may be as course as 100ms, so the accuracy may be off by + up to 50ms.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the last access time of the region or the entry's value; + returns 0 if entry is invalid or access time is uninitialized.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></code> - if statistics are not available</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastModifiedTime--"><code>getLastModifiedTime()</code></a></dd> +</dl> +</li> +</ul> +<a name="getMissCount--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMissCount</h4> +<pre>long getMissCount() + throws <a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></pre> +<div class="block">Returns the number of times that <a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get</code></a> on + the region or the entry was called and there was no value found + locally. Unlike <code>lastAccessedTime</code>, the miss count is + not propagated to parent regions. Note that remote operations + such as a "net search" do not effect the miss count.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of cache misses on the region or the + entry.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></code> - if statistics are not available</dd> +</dl> +</li> +</ul> +<a name="getHitCount--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHitCount</h4> +<pre>long getHitCount() + throws <a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></pre> +<div class="block">Returns the number of hits for this region or entry. The number + of hits is defined as the number of times when the + <a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get</code></a> finds a value locally. Unlike + <code>lastAccessedTime</code>, the hit count is not propagated to + parent regions. Note that remote operations such as a "net + search" do not effect the hit count.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of hits for this region or entry.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></code> - if statistics are not available</dd> +</dl> +</li> +</ul> +<a name="getHitRatio--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHitRatio</h4> +<pre>float getHitRatio() + throws <a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></pre> +<div class="block">Return the hit ratio, a convenience method defined as the ratio of hits + to the number of calls to <a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>Region.get</code></a>. If there have been zero + calls to <code>Region.get</code>, then zero is returned. + <p> + The hit ratio is equivalent to: + <pre> + long hitCount = getHitCount(); + long total = hitCount + getMissCount(); + return total == 0L ? 0.0f : ((float)hitCount / total); + </pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the hit ratio as a float</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></code> - if statistics are not available</dd> +</dl> +</li> +</ul> +<a name="resetCounts--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>resetCounts</h4> +<pre>void resetCounts() + throws <a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></pre> +<div class="block">Reset the missCount and hitCount to zero for this entry.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/StatisticsDisabledException.html" title="class in com.gemstone.gemfire.cache">StatisticsDisabledException</a></code> - if statistics are not available</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="../../../../com/gemstone/gemfire/cache/CacheRuntimeException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/CacheStatistics.html" target="_top">Frames</a></li> +<li><a href="CacheStatistics.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>