http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomEvictionAttributes.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomEvictionAttributes.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomEvictionAttributes.html new file mode 100644 index 0000000..1341ab9 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomEvictionAttributes.html @@ -0,0 +1,345 @@ +<!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>CustomEvictionAttributes (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="CustomEvictionAttributes (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/CommitIncompleteException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.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/CustomEvictionAttributes.html" target="_top">Frames</a></li> +<li><a href="CustomEvictionAttributes.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 CustomEvictionAttributes" class="title">Class CustomEvictionAttributes</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.CustomEvictionAttributes</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">CustomEvictionAttributes</span> +extends java.lang.Object</pre> +<div class="block">Custom eviction attributes including <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionCriteria</code></a> and evictor + start time and frequency, if any.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>gfxd 1.0</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#CustomEvictionAttributes-com.gemstone.gemfire.cache.EvictionCriteria-long-long-boolean-">CustomEvictionAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache">EvictionCriteria</a><?,?> criteria, + long startTime, + long interval, + boolean evictIncoming)</code> </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><K,V> <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache">EvictionCriteria</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#getCriteria--">getCriteria</a></span>()</code> +<div class="block">Get the <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionCriteria</code></a> for this custom eviction.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#getEvictorInterval--">getEvictorInterval</a></span>()</code> +<div class="block">The intervals at which the periodic evictor task is fired and + <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionCriteria</code></a> evaluated to evict entries.</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/CustomEvictionAttributes.html#getEvictorStartTime--">getEvictorStartTime</a></span>()</code> +<div class="block">The absolute start time in milliseconds (as returned by + <code>System.currentTimeMillis()</code>) when the evictor will be first fired.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#isEvictIncoming--">isEvictIncoming</a></span>()</code> +<div class="block">If this returns true, then the criteria should always be applied to + incoming entries and never as a periodic task.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="CustomEvictionAttributes-com.gemstone.gemfire.cache.EvictionCriteria-long-long-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CustomEvictionAttributes</h4> +<pre>protected CustomEvictionAttributes(<a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache">EvictionCriteria</a><?,?> criteria, + long startTime, + long interval, + boolean evictIncoming)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCriteria--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCriteria</h4> +<pre>public <K,V> <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache">EvictionCriteria</a><K,V> getCriteria()</pre> +<div class="block">Get the <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionCriteria</code></a> for this custom eviction. The criteria + will be applied to the region entries either periodically as per + <a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#getEvictorStartTime--"><code>getEvictorStartTime()</code></a> and <a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#getEvictorInterval--"><code>getEvictorInterval()</code></a>, or on + incoming puts if <a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#isEvictIncoming--"><code>isEvictIncoming()</code></a> is true.</div> +</li> +</ul> +<a name="getEvictorStartTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvictorStartTime</h4> +<pre>public final long getEvictorStartTime()</pre> +<div class="block">The absolute start time in milliseconds (as returned by + <code>System.currentTimeMillis()</code>) when the evictor will be first fired. + Thereafter the evictor will be fired periodically every + <a href="../../../../com/gemstone/gemfire/cache/CustomEvictionAttributes.html#getEvictorInterval--"><code>getEvictorInterval()</code></a> milliseconds.</div> +</li> +</ul> +<a name="getEvictorInterval--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvictorInterval</h4> +<pre>public final long getEvictorInterval()</pre> +<div class="block">The intervals at which the periodic evictor task is fired and + <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionCriteria</code></a> evaluated to evict entries.</div> +</li> +</ul> +<a name="isEvictIncoming--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isEvictIncoming</h4> +<pre>public final boolean isEvictIncoming()</pre> +<div class="block">If this returns true, then the criteria should always be applied to + incoming entries and never as a periodic task.</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="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/CommitIncompleteException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.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/CustomEvictionAttributes.html" target="_top">Frames</a></li> +<li><a href="CustomEvictionAttributes.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/CustomExpiry.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomExpiry.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomExpiry.html new file mode 100644 index 0000000..4449fce --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/CustomExpiry.html @@ -0,0 +1,253 @@ +<!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>CustomExpiry (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="CustomExpiry (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/CustomEvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.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/CustomExpiry.html" target="_top">Frames</a></li> +<li><a href="CustomExpiry.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 CustomExpiry" class="title">Interface CustomExpiry<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html" title="interface in com.gemstone.gemfire.cache">CacheCallback</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/gemstone/gemfire/modules/util/SessionCustomExpiry.html" title="class in com.gemstone.gemfire.modules.util">SessionCustomExpiry</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">CustomExpiry<K,V></span> +extends <a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html" title="interface in com.gemstone.gemfire.cache">CacheCallback</a></pre> +<div class="block">This is the contract that a <code>custom-expiry</code> element must honor. + It determines the expiration characteristics for a specific entry in a region. + <p>Note that if you wish to refer to an implementation of this interface in XML, + the implementation must also implement the Declarable 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"> </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><a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html#getExpiry-com.gemstone.gemfire.cache.Region.Entry-">getExpiry</a></span>(<a href="../../../../com/gemstone/gemfire/cache/Region.Entry.html" title="interface in com.gemstone.gemfire.cache">Region.Entry</a><<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="type parameter in CustomExpiry">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="type parameter in CustomExpiry">V</a>> entry)</code> +<div class="block">Calculate the expiration for a given entry.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.cache.CacheCallback"> +<!-- --> +</a> +<h3>Methods inherited from interface com.gemstone.gemfire.cache.<a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html" title="interface in com.gemstone.gemfire.cache">CacheCallback</a></h3> +<code><a href="../../../../com/gemstone/gemfire/cache/CacheCallback.html#close--">close</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="getExpiry-com.gemstone.gemfire.cache.Region.Entry-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getExpiry</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> getExpiry(<a href="../../../../com/gemstone/gemfire/cache/Region.Entry.html" title="interface in com.gemstone.gemfire.cache">Region.Entry</a><<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="type parameter in CustomExpiry">K</a>,<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="type parameter in CustomExpiry">V</a>> entry)</pre> +<div class="block">Calculate the expiration for a given entry. + Returning null indicates that the + default for the region should be used. + <p> + The entry parameter should not be used after this method invocation completes.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>entry</code> - the entry to calculate the expiration for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the expiration to be used, null if the region's defaults should be + used.</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/CustomEvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.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/CustomExpiry.html" target="_top">Frames</a></li> +<li><a href="CustomExpiry.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> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/DataPolicy.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/DataPolicy.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/DataPolicy.html new file mode 100644 index 0000000..fba5fcc --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/DataPolicy.html @@ -0,0 +1,781 @@ +<!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>DataPolicy (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="DataPolicy (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/CustomExpiry.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/Declarable.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/DataPolicy.html" target="_top">Frames</a></li> +<li><a href="DataPolicy.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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="Class DataPolicy" class="title">Class DataPolicy</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.DataPolicy</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">DataPolicy</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">Enumerated type for region data policy. + The data policy specifies how this local cache will handle the data for a region. + <ol> + <li><code>EMPTY</code> causes data to never be stored in local memory. The region will always appear empty. It can be used to for zero footprint producers that only want to distribute their data to others and for zero footprint consumers that only want to see events. + <li><code>NORMAL</code> causes data that this region is interested in to be stored in local memory. It allows the contents in this cache to differ from other caches. + <li><code>PARTITION</code> causes data that this region holds to be spread across processes. The amount of data held in this cache is configured in <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a> with a <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html" title="class in com.gemstone.gemfire.cache"><code>PartitionAttributesFactory</code></a>. + <li><code>PERSISTENT_PARTITION</code> in addition to <code>PARTITION</code> also causes data to be stored to disk. The region initialization uses the data stored on disk. + <li><code>REPLICATE</code> causes data that this region is interested in to be stored in local memory. A distributed region will be initialized with the data from other caches. On distributed region operations that would cause the contents to differ with other caches are not allowed. This policy is allowed on local scope region but it behaves the same as <code>NORMAL</code>. + <li><code>PERSISTENT_REPLICATE</code> in addition to <code>REPLICATE</code> also causes data to be stored to disk. The region initialization uses the data stored on disk. Note that the persistence applies to both local scope and distributed scope. + <li><code>HDFS_PARTITION</code> in addition to <code>PARTITION</code> also causes data to be stored to HDFS. The region initialization may use the data stored on HDFS. + </ol></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDataPolicy-com.gemstone.gemfire.cache.DataPolicy-"><code>AttributesFactory.setDataPolicy(com.gemstone.gemfire.cache.DataPolicy)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getDataPolicy--"><code>RegionAttributes.getDataPolicy()</code></a>, +<a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.DataPolicy">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#DEFAULT">DEFAULT</a></span></code> +<div class="block">The data policy used by default; it is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#EMPTY">EMPTY</a></span></code> +<div class="block">Data is never stored in local memory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL">NORMAL</a></span></code> +<div class="block">Allows the contents in this cache to differ from other caches.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#ordinal">ordinal</a></span></code> +<div class="block">used as ordinal to represent this DataPolicy</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION">PARTITION</a></span></code> +<div class="block">Data in this region may be spread across a number of processes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_PARTITION">PERSISTENT_PARTITION</a></span></code> +<div class="block">In addition to <code>PARTITION</code> also causes data to be stored to + disk.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE">PERSISTENT_REPLICATE</a></span></code> +<div class="block">In addition to <code>REPLICATE</code> also causes data to be stored to + disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED">PRELOADED</a></span></code> +<div class="block">In addition to <code>NORMAL</code>, contents inside of this cache are + (partially) initialized with data from other caches, if available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#REPLICATE">REPLICATE</a></span></code> +<div class="block">The region will be initialized with the data from other caches and accepts + any new entries created in other caches.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#fromOrdinal-byte-">fromOrdinal</a></span>(byte ordinal)</code> +<div class="block">Return the DataPolicy represented by specified ordinal</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isDefault--">isDefault</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div> +</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isEmpty--">isEmpty</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use withStorage()</span></div> +</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isNormal--">isNormal</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div> +</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isPartition--">isPartition</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use withPartitioning()</span></div> +</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isPersistentReplicate--">isPersistentReplicate</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use withPersistence() and withReplication()</span></div> +</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isPreloaded--">isPreloaded</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use withPreloaded()</span></div> +</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#isReplicate--">isReplicate</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">from version 6.5 forward please use withReplication()</span></div> +</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string representation for this data policy.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withHDFS--">withHDFS</a></span>()</code> +<div class="block">Return whether this policy does persistence on HDFS.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withPartitioning--">withPartitioning</a></span>()</code> +<div class="block">Return whether this policy does partitioning.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withPersistence--">withPersistence</a></span>()</code> +<div class="block">Return whether this policy does persistence.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withPreloaded--">withPreloaded</a></span>()</code> +<div class="block">Return whether this policy does preloaded.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withReplication--">withReplication</a></span>()</code> +<div class="block">Return whether this policy does replication.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withStorage--">withStorage</a></span>()</code> +<div class="block">Return true if regions with this policy store data locally.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="EMPTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EMPTY</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> EMPTY</pre> +<div class="block">Data is never stored in local memory. + The region will always be empty locally. + It can be used to for zero footprint producers that only want to distribute + their data to others + and for zero footprint consumers that only want to see events.</div> +</li> +</ul> +<a name="NORMAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NORMAL</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> NORMAL</pre> +<div class="block">Allows the contents in this cache to differ from other caches.<p> + Data that this region is interested in is stored in local memory.</div> +</li> +</ul> +<a name="REPLICATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REPLICATE</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> REPLICATE</pre> +<div class="block">The region will be initialized with the data from other caches and accepts + any new entries created in other caches.<p> + Operations that would cause the contents to differ with other caches + are not allowed.<p> + Data that this region is interested in is stored in local memory.</div> +</li> +</ul> +<a name="PERSISTENT_REPLICATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PERSISTENT_REPLICATE</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> PERSISTENT_REPLICATE</pre> +<div class="block">In addition to <code>REPLICATE</code> also causes data to be stored to + disk. The region initialization may use the data stored on disk.</div> +</li> +</ul> +<a name="PARTITION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PARTITION</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> PARTITION</pre> +<div class="block">Data in this region may be spread across a number of processes. This is + further configured with <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>partitioning attributes</code></a></div> +</li> +</ul> +<a name="PRELOADED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PRELOADED</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> PRELOADED</pre> +<div class="block">In addition to <code>NORMAL</code>, contents inside of this cache are + (partially) initialized with data from other caches, if available.</div> +</li> +</ul> +<a name="PERSISTENT_PARTITION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PERSISTENT_PARTITION</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> PERSISTENT_PARTITION</pre> +<div class="block">In addition to <code>PARTITION</code> also causes data to be stored to + disk. The region initialization may use the data stored on disk.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +</dl> +</li> +</ul> +<a name="DEFAULT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> DEFAULT</pre> +<div class="block">The data policy used by default; it is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</div> +</li> +</ul> +<a name="ordinal"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ordinal</h4> +<pre>public final byte ordinal</pre> +<div class="block">used as ordinal to represent this DataPolicy</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fromOrdinal-byte-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromOrdinal</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> fromOrdinal(byte ordinal)</pre> +<div class="block">Return the DataPolicy represented by specified ordinal</div> +</li> +</ul> +<a name="withStorage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withStorage</h4> +<pre>public boolean withStorage()</pre> +<div class="block">Return true if regions with this policy store data locally.<p> + Although DataPolicy <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a> will return true to this query, + it is possible to turn off local storage with + <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>PartitionAttributesFactory.setLocalMaxMemory(int)</code></a> by setting + localMaxMemory to zero.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if regions with this policy store data locally.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>PERSISTENT_PARTITION</code></a></dd> +</dl> +</li> +</ul> +<a name="withReplication--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withReplication</h4> +<pre>public boolean withReplication()</pre> +<div class="block">Return whether this policy does replication.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy does replication.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a></dd> +</dl> +</li> +</ul> +<a name="withPersistence--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withPersistence</h4> +<pre>public boolean withPersistence()</pre> +<div class="block">Return whether this policy does persistence.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy does persistence.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>PERSISTENT_PARTITION</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a></dd> +</dl> +</li> +</ul> +<a name="withPartitioning--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withPartitioning</h4> +<pre>public boolean withPartitioning()</pre> +<div class="block">Return whether this policy does partitioning.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy does partitioning</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>PERSISTENT_PARTITION</code></a></dd> +</dl> +</li> +</ul> +<a name="withPreloaded--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withPreloaded</h4> +<pre>public boolean withPreloaded()</pre> +<div class="block">Return whether this policy does preloaded.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy does preloaded.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a></dd> +</dl> +</li> +</ul> +<a name="isEmpty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use withStorage()</span></div> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#EMPTY"><code>EMPTY</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#EMPTY"><code>EMPTY</code></a>.</dd> +</dl> +</li> +</ul> +<a name="isNormal--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNormal</h4> +<pre>public boolean isNormal()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</dd> +</dl> +</li> +</ul> +<a name="isPreloaded--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPreloaded</h4> +<pre>public boolean isPreloaded()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use withPreloaded()</span></div> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a></dd> +</dl> +</li> +</ul> +<a name="isDefault--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDefault</h4> +<pre>public boolean isDefault()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div> +<div class="block">Return true if this policy is the default.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is the default.</dd> +</dl> +</li> +</ul> +<a name="isReplicate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReplicate</h4> +<pre>public boolean isReplicate()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use withReplication()</span></div> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>.</dd> +</dl> +</li> +</ul> +<a name="isPersistentReplicate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPersistentReplicate</h4> +<pre>public boolean isPersistentReplicate()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use withPersistence() and withReplication()</span></div> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a>.</dd> +</dl> +</li> +</ul> +<a name="isPartition--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPartition</h4> +<pre>public boolean isPartition()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">from version 6.5 forward please use withPartitioning()</span></div> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a></dd> +</dl> +</li> +</ul> +<a name="withHDFS--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withHDFS</h4> +<pre>public boolean withHDFS()</pre> +<div class="block">Return whether this policy does persistence on HDFS.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy does persistence on HDFS.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns a string representation for this data policy.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of this data policy.</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/CustomExpiry.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/Declarable.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/DataPolicy.html" target="_top">Frames</a></li> +<li><a href="DataPolicy.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/Declarable.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/Declarable.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/Declarable.html new file mode 100644 index 0000000..c06067c --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/Declarable.html @@ -0,0 +1,273 @@ +<!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>Declarable (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="Declarable (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/DataPolicy.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/DiskAccessException.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/Declarable.html" target="_top">Frames</a></li> +<li><a href="Declarable.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 Declarable" class="title">Interface Declarable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/util/AutoBalancer.html" title="class in com.gemstone.gemfire.cache.util">AutoBalancer</a>, <a href="../../../../com/gemstone/gemfire/modules/util/CreateRegionFunction.html" title="class in com.gemstone.gemfire.modules.util">CreateRegionFunction</a>, <a href="../../../../com/gemstone/gemfire/modules/util/DebugCacheListener.html" title="class in com.gemstone.gemfire.modules.util">DebugCacheListener</a>, <a href="../../../../com/gemstone/gemfire/modules/gatewaydelta/GatewayDeltaEventApplicationCacheListener.html" title="class in com.gemstone.gemfire.modules.gatewaydelta">GatewayDeltaEventApplicationCacheListener</a>, <a href="../../../../com/gemstone/gemfire/modules/gatewaydelta/GatewayDeltaForwarderCacheListener.html" title="class in com.gemstone.gemfire.modules.gatewaydelta">GatewayDeltaForwarderCacheListener</a>, <a href="../../../../com/gemstone/gemfire/modules/hibernate/GemFireCacheListener.html" title="class in com.gemstone.gemf ire.modules.hibernate">GemFireCacheListener</a>, <a href="../../../../com/gemstone/gemfire/modules/session/catalina/callback/LocalSessionCacheLoader.html" title="class in com.gemstone.gemfire.modules.session.catalina.callback">LocalSessionCacheLoader</a>, <a href="../../../../com/gemstone/gemfire/modules/session/catalina/callback/LocalSessionCacheWriter.html" title="class in com.gemstone.gemfire.modules.session.catalina.callback">LocalSessionCacheWriter</a>, <a href="../../../../com/gemstone/gemfire/pdx/ReflectionBasedAutoSerializer.html" title="class in com.gemstone.gemfire.pdx">ReflectionBasedAutoSerializer</a>, <a href="../../../../com/gemstone/gemfire/modules/util/RegionConfigurationCacheListener.html" title="class in com.gemstone.gemfire.modules.util">RegionConfigurationCacheListener</a>, <a href="../../../../com/gemstone/gemfire/modules/util/RegionSizeFunction.html" title="class in com.gemstone.gemfire.modules.util">RegionSizeFunction</a>, <a href="../../../../com/gemstone/gem fire/modules/util/SessionCustomExpiry.html" title="class in com.gemstone.gemfire.modules.util">SessionCustomExpiry</a>, <a href="../../../../com/gemstone/gemfire/modules/session/catalina/callback/SessionExpirationCacheListener.html" title="class in com.gemstone.gemfire.modules.session.catalina.callback">SessionExpirationCacheListener</a>, <a href="../../../../com/gemstone/gemfire/modules/util/TouchPartitionedRegionEntriesFunction.html" title="class in com.gemstone.gemfire.modules.util">TouchPartitionedRegionEntriesFunction</a>, <a href="../../../../com/gemstone/gemfire/modules/util/TouchReplicatedRegionEntriesFunction.html" title="class in com.gemstone.gemfire.modules.util">TouchReplicatedRegionEntriesFunction</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">Declarable</span></pre> +<div class="block">An object that can be described in a declarative caching XML file. + + <p> + + Any user-defined object in the declarative caching xml file + should implement this interface in order to be constructed. + + <p> + + For example, the user can declare a <code>CacheLoader</code> in a declarative + XML file as follows: + + <pre> + <cache-loader> + <class-name>com.company.app.DBLoader</class-name> + <parameter name="URL"> + <string>jdbc://12.34.56.78/mydb</string> + </parameter> + </cache-loader> + </pre> + + <p> + + In this case, <code>com.company.app.DBLoader</code> must + implement both the <a href="../../../../com/gemstone/gemfire/cache/CacheLoader.html" title="interface in com.gemstone.gemfire.cache"><code>CacheLoader</code></a> and <code>Declarable</code> + interfaces. The cache service will construct a + <code>com.company.app.DBLoader</code> object by invoking the loader's + zero-argument constructor and then calling the <a href="../../../../com/gemstone/gemfire/cache/Declarable.html#init-java.util.Properties-"><code>init(java.util.Properties)</code></a> method + to pass in the parameters. + + <P> + + See <a href="package-summary.html#declarative">package introduction</a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.0</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/Declarable.html#init-java.util.Properties-">init</a></span>(java.util.Properties props)</code> +<div class="block">Initializes a user-defined object using the given properties.</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="init-java.util.Properties-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(java.util.Properties props)</pre> +<div class="block">Initializes a user-defined object using the given properties. + Note that any uncaught exception thrown by this method will cause + the <code>Cache</code> initialization to fail.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>props</code> - Contains the parameters declared in the declarative xml + file.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - If one of the configuration options in <code>props</code> + is illegal or malformed.</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/DataPolicy.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/DiskAccessException.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/Declarable.html" target="_top">Frames</a></li> +<li><a href="Declarable.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>
