http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/GemFireCache.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/GemFireCache.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/GemFireCache.html new file mode 100644 index 0000000..717149a --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/GemFireCache.html @@ -0,0 +1,782 @@ +<!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>GemFireCache (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="GemFireCache (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":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/GatewayException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/IncompatibleVersionException.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/GemFireCache.html" target="_top">Frames</a></li> +<li><a href="GemFireCache.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 GemFireCache" class="title">Interface GemFireCache</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.lang.AutoCloseable, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html" title="interface in com.gemstone.gemfire.cache">RegionService</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/Cache.html" title="interface in com.gemstone.gemfire.cache">Cache</a>, <a href="../../../../com/gemstone/gemfire/cache/client/ClientCache.html" title="interface in com.gemstone.gemfire.cache.client">ClientCache</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">GemFireCache</span> +extends <a href="../../../../com/gemstone/gemfire/cache/RegionService.html" title="interface in com.gemstone.gemfire.cache">RegionService</a></pre> +<div class="block">GemFireCache represents the singleton cache that must be created + in order to use GemFire in a Java virtual machine. + Users must create either a <a href="../../../../com/gemstone/gemfire/cache/Cache.html" title="interface in com.gemstone.gemfire.cache"><code>Cache</code></a> for a peer/server JVM + or a <a href="../../../../com/gemstone/gemfire/cache/client/ClientCache.html" title="interface in com.gemstone.gemfire.cache.client"><code>ClientCache</code></a> for a client JVM. + Instances of this interface are created using one of the following methods: + <ul> + <li> <a href="../../../../com/gemstone/gemfire/cache/CacheFactory.html#create--"><code>CacheFactory.create()</code></a> creates a peer/server instance of <a href="../../../../com/gemstone/gemfire/cache/Cache.html" title="interface in com.gemstone.gemfire.cache"><code>Cache</code></a>. + <li> <a href="../../../../com/gemstone/gemfire/cache/client/ClientCacheFactory.html#create--"><code>ClientCacheFactory.create()</code></a> creates a client instance of <a href="../../../../com/gemstone/gemfire/cache/client/ClientCache.html" title="interface in com.gemstone.gemfire.cache.client"><code>ClientCache</code></a>. + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</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><a href="../../../../com/gemstone/gemfire/cache/DiskStoreFactory.html" title="interface in com.gemstone.gemfire.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#createDiskStoreFactory--">createDiskStoreFactory</a></span>()</code> +<div class="block">create diskstore factory</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/wan/GatewaySenderFactory.html" title="interface in com.gemstone.gemfire.cache.wan">GatewaySenderFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#createGatewaySenderFactory--">createGatewaySenderFactory</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/DiskStore.html" title="interface in com.gemstone.gemfire.cache">DiskStore</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#findDiskStore-java.lang.String-">findDiskStore</a></span>(java.lang.String name)</code> +<div class="block">Returns the DiskStore by name or <code>null</code> if no disk store is found.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache">CacheTransactionManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getCacheTransactionManager--">getCacheTransactionManager</a></span>()</code> +<div class="block">Get the CacheTransactionManager instance for this Cache.</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/GemFireCache.html#getCopyOnRead--">getCopyOnRead</a></span>()</code> +<div class="block">Indicates whether the "copy on read" is enabled for this cache.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/distributed/DistributedSystem.html" title="class in com.gemstone.gemfire.distributed">DistributedSystem</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getDistributedSystem--">getDistributedSystem</a></span>()</code> +<div class="block">Returns the distributed system used by this cache.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/Declarable.html" title="interface in com.gemstone.gemfire.cache">Declarable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getInitializer--">getInitializer</a></span>()</code> +<div class="block">Returns the Declarable used to initialize this cache or <code>null</code> + if it does not have an initializer.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.util.Properties</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getInitializerProps--">getInitializerProps</a></span>()</code> +<div class="block">Returns the Properties used to initialize the cache initializer or + <code>null</code> if no initializer properties exist.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>javax.naming.Context</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getJNDIContext--">getJNDIContext</a></span>()</code> +<div class="block">Returns the JNDI context associated with the Cache.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/LogWriter.html" title="interface in com.gemstone.gemfire">LogWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getLogger--">getLogger</a></span>()</code> +<div class="block">Gets the logging object for GemFire.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getName--">getName</a></span>()</code> +<div class="block">Returns the name of this cache.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getPdxDiskStore--">getPdxDiskStore</a></span>()</code> +<div class="block">Returns the disk store used for PDX meta data</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/GemFireCache.html#getPdxIgnoreUnreadFields--">getPdxIgnoreUnreadFields</a></span>()</code> +<div class="block">Returns true if fields that are not read during PDX deserialization + should be ignored during the PDX serialization.</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/GemFireCache.html#getPdxPersistent--">getPdxPersistent</a></span>()</code> +<div class="block">Returns true if the PDX metadata for this + cache is persistent</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/GemFireCache.html#getPdxReadSerialized--">getPdxReadSerialized</a></span>()</code> +<div class="block">Returns whether { @link PdxInstance} is preferred for PDX types instead of Java object.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/pdx/PdxSerializer.html" title="interface in com.gemstone.gemfire.pdx">PdxSerializer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getPdxSerializer--">getPdxSerializer</a></span>()</code> +<div class="block">Returns the PdxSerializer used by this cache, or null + if no PDX serializer is defined.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><K,V> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><K,V></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getRegionAttributes-java.lang.String-">getRegionAttributes</a></span>(java.lang.String id)</code> +<div class="block">Returns the <code>RegionAttributes</code> with the given + <code>id</code> or <code>null</code> if no + <code>RegionAttributes</code> with that id exists.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/control/ResourceManager.html" title="interface in com.gemstone.gemfire.cache.control">ResourceManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getResourceManager--">getResourceManager</a></span>()</code> +<div class="block">Returns the <code>ResourceManager</code> for managing this cache's + resources.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/LogWriter.html" title="interface in com.gemstone.gemfire">LogWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getSecurityLogger--">getSecurityLogger</a></span>()</code> +<div class="block">Gets the security logging object for GemFire.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code><K,V> java.util.Map<java.lang.String,<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><K,V>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#listRegionAttributes--">listRegionAttributes</a></span>()</code> +<div class="block">Returns an unmodifiable mapping of ids to region attributes.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#loadCacheXml-java.io.InputStream-">loadCacheXml</a></span>(java.io.InputStream is)</code> +<div class="block">Loads the cache configuration described in a <a + href="package-summary.html#declarative">declarative caching XML + file</a> into this cache.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#setCopyOnRead-boolean-">setCopyOnRead</a></span>(boolean copyOnRead)</code> +<div class="block">Sets the "copy on read" feature for cache read operations.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code><K,V> void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#setRegionAttributes-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-">setRegionAttributes</a></span>(java.lang.String id, + <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><K,V> attrs)</code> +<div class="block">Sets the <code>id</code> of the given + <code>RegionAttributes</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.cache.RegionService"> +<!-- --> +</a> +<h3>Methods inherited from interface com.gemstone.gemfire.cache.<a href="../../../../com/gemstone/gemfire/cache/RegionService.html" title="interface in com.gemstone.gemfire.cache">RegionService</a></h3> +<code><a href="../../../../com/gemstone/gemfire/cache/RegionService.html#close--">close</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#createPdxEnum-java.lang.String-java.lang.String-int-">createPdxEnum</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#createPdxInstanceFactory-java.lang.String-">createPdxInstanceFactory</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#getCancelCriterion--">getCancelCriterion</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#getQueryService--">getQueryService</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#getRegion-java.lang.String-">getRegion</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#isClosed--">isClosed</a>, <a href="../../../../com/gemstone/gemfire/cache/RegionService.html#rootRegions--">rootRegions</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="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this cache. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the String name of this cache</dd> +</dl> +</li> +</ul> +<a name="getDistributedSystem--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDistributedSystem</h4> +<pre><a href="../../../../com/gemstone/gemfire/distributed/DistributedSystem.html" title="class in com.gemstone.gemfire.distributed">DistributedSystem</a> getDistributedSystem()</pre> +<div class="block">Returns the distributed system used by this cache. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +</li> +</ul> +<a name="getResourceManager--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceManager</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/control/ResourceManager.html" title="interface in com.gemstone.gemfire.cache.control">ResourceManager</a> getResourceManager()</pre> +<div class="block">Returns the <code>ResourceManager</code> for managing this cache's + resources.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>ResourceManager</code> for managing this cache's resources</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.0</dd> +</dl> +</li> +</ul> +<a name="setCopyOnRead-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCopyOnRead</h4> +<pre>void setCopyOnRead(boolean copyOnRead)</pre> +<div class="block">Sets the "copy on read" feature for cache read operations.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.0</dd> +</dl> +</li> +</ul> +<a name="getCopyOnRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCopyOnRead</h4> +<pre>boolean getCopyOnRead()</pre> +<div class="block">Indicates whether the "copy on read" is enabled for this cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if "copy on read" is enabled, false otherwise.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.0</dd> +</dl> +</li> +</ul> +<a name="getRegionAttributes-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegionAttributes</h4> +<pre><K,V> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><K,V> getRegionAttributes(java.lang.String id)</pre> +<div class="block">Returns the <code>RegionAttributes</code> with the given + <code>id</code> or <code>null</code> if no + <code>RegionAttributes</code> with that id exists.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.1</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#setRegionAttributes-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-"><code>setRegionAttributes(java.lang.String, com.gemstone.gemfire.cache.RegionAttributes<K, V>)</code></a></dd> +</dl> +</li> +</ul> +<a name="setRegionAttributes-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRegionAttributes</h4> +<pre><K,V> void setRegionAttributes(java.lang.String id, + <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><K,V> attrs)</pre> +<div class="block">Sets the <code>id</code> of the given + <code>RegionAttributes</code>. If a region attributes named + <code>name</code> already exists, the mapping will be overwritten + with <code>attrs</code>. However, changing the mapping will not + effect existing regions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - The id of the region attributes</dd> +<dd><code>attrs</code> - The attributes to associate with <code>id</code>. If + <code>attrs</code> is <code>null</code>, any existing + <code>RegionAttributes</code> associated with + <code>id</code> will be removed.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.1</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/GemFireCache.html#getRegionAttributes-java.lang.String-"><code>getRegionAttributes(java.lang.String)</code></a></dd> +</dl> +</li> +</ul> +<a name="listRegionAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listRegionAttributes</h4> +<pre><K,V> java.util.Map<java.lang.String,<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><K,V>> listRegionAttributes()</pre> +<div class="block">Returns an unmodifiable mapping of ids to region attributes. The + keys of the map are <code>String</code>s and the values of the map are + <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>RegionAttributes</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.1</dd> +</dl> +</li> +</ul> +<a name="loadCacheXml-java.io.InputStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadCacheXml</h4> +<pre>void loadCacheXml(java.io.InputStream is) + throws <a href="../../../../com/gemstone/gemfire/cache/TimeoutException.html" title="class in com.gemstone.gemfire.cache">TimeoutException</a>, + <a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a>, + <a href="../../../../com/gemstone/gemfire/cache/GatewayException.html" title="class in com.gemstone.gemfire.cache">GatewayException</a>, + <a href="../../../../com/gemstone/gemfire/cache/RegionExistsException.html" title="class in com.gemstone.gemfire.cache">RegionExistsException</a></pre> +<div class="block">Loads the cache configuration described in a <a + href="package-summary.html#declarative">declarative caching XML + file</a> into this cache. If the XML describes a region that + already exists, any mutable region attributes, indexes, and + region entries that are defined in the XML are updated/added. + + <P> + + Because this method may perform a <a href="../../../../com/gemstone/gemfire/cache/Region.html#put-K-V-"><code>put</code></a> on a + <code>Region</code>, it declares that it throws a + <code>TimeoutException</code>, <code>CacheWriterException</code>, + <code>GatewayException</code>, + or <code>RegionExistsException</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheXmlException.html" title="class in com.gemstone.gemfire.cache">CacheXmlException</a></code> - If the XML read from <code>is</code> does not conform to + the dtd or if an <code>IOException</code> occurs while + reading the XML.</dd> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/TimeoutException.html" title="class in com.gemstone.gemfire.cache">TimeoutException</a></code></dd> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheWriterException.html" title="class in com.gemstone.gemfire.cache">CacheWriterException</a></code></dd> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/GatewayException.html" title="class in com.gemstone.gemfire.cache">GatewayException</a></code></dd> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/RegionExistsException.html" title="class in com.gemstone.gemfire.cache">RegionExistsException</a></code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.1</dd> +</dl> +</li> +</ul> +<a name="getLogger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogger</h4> +<pre><a href="../../../../com/gemstone/gemfire/LogWriter.html" title="interface in com.gemstone.gemfire">LogWriter</a> getLogger()</pre> +<div class="block">Gets the logging object for GemFire. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the logging object</dd> +</dl> +</li> +</ul> +<a name="getSecurityLogger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSecurityLogger</h4> +<pre><a href="../../../../com/gemstone/gemfire/LogWriter.html" title="interface in com.gemstone.gemfire">LogWriter</a> getSecurityLogger()</pre> +<div class="block">Gets the security logging object for GemFire. + This method does not throw + <code>CacheClosedException</code> if the cache is closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the security logging object</dd> +</dl> +</li> +</ul> +<a name="findDiskStore-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findDiskStore</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/DiskStore.html" title="interface in com.gemstone.gemfire.cache">DiskStore</a> findDiskStore(java.lang.String name)</pre> +<div class="block">Returns the DiskStore by name or <code>null</code> if no disk store is found.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the disk store to find. If <code>null</code> then the + default disk store, if it exists, is returned.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +</dl> +</li> +</ul> +<a name="createDiskStoreFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDiskStoreFactory</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/DiskStoreFactory.html" title="interface in com.gemstone.gemfire.cache">DiskStoreFactory</a> createDiskStoreFactory()</pre> +<div class="block">create diskstore factory</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +</dl> +</li> +</ul> +<a name="createGatewaySenderFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createGatewaySenderFactory</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/wan/GatewaySenderFactory.html" title="interface in com.gemstone.gemfire.cache.wan">GatewaySenderFactory</a> createGatewaySenderFactory()</pre> +</li> +</ul> +<a name="getPdxReadSerialized--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPdxReadSerialized</h4> +<pre>boolean getPdxReadSerialized()</pre> +<div class="block">Returns whether { @link PdxInstance} is preferred for PDX types instead of Java object.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheFactory.html#setPdxReadSerialized-boolean-"><code>CacheFactory.setPdxReadSerialized(boolean)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/client/ClientCacheFactory.html#setPdxReadSerialized-boolean-"><code>ClientCacheFactory.setPdxReadSerialized(boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="getPdxSerializer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPdxSerializer</h4> +<pre><a href="../../../../com/gemstone/gemfire/pdx/PdxSerializer.html" title="interface in com.gemstone.gemfire.pdx">PdxSerializer</a> getPdxSerializer()</pre> +<div class="block">Returns the PdxSerializer used by this cache, or null + if no PDX serializer is defined.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheFactory.html#setPdxSerializer-com.gemstone.gemfire.pdx.PdxSerializer-"><code>CacheFactory.setPdxSerializer(PdxSerializer)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/client/ClientCacheFactory.html#setPdxSerializer-com.gemstone.gemfire.pdx.PdxSerializer-"><code>ClientCacheFactory.setPdxSerializer(PdxSerializer)</code></a></dd> +</dl> +</li> +</ul> +<a name="getPdxDiskStore--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPdxDiskStore</h4> +<pre>java.lang.String getPdxDiskStore()</pre> +<div class="block">Returns the disk store used for PDX meta data</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheFactory.html#setPdxDiskStore-java.lang.String-"><code>CacheFactory.setPdxDiskStore(String)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/client/ClientCacheFactory.html#setPdxDiskStore-java.lang.String-"><code>ClientCacheFactory.setPdxDiskStore(String)</code></a></dd> +</dl> +</li> +</ul> +<a name="getPdxPersistent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPdxPersistent</h4> +<pre>boolean getPdxPersistent()</pre> +<div class="block">Returns true if the PDX metadata for this + cache is persistent</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheFactory.html#setPdxPersistent-boolean-"><code>CacheFactory.setPdxPersistent(boolean)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/client/ClientCacheFactory.html#setPdxPersistent-boolean-"><code>ClientCacheFactory.setPdxPersistent(boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="getPdxIgnoreUnreadFields--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPdxIgnoreUnreadFields</h4> +<pre>boolean getPdxIgnoreUnreadFields()</pre> +<div class="block">Returns true if fields that are not read during PDX deserialization + should be ignored during the PDX serialization.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/CacheFactory.html#setPdxIgnoreUnreadFields-boolean-"><code>CacheFactory.setPdxIgnoreUnreadFields(boolean)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/client/ClientCacheFactory.html#setPdxIgnoreUnreadFields-boolean-"><code>ClientCacheFactory.setPdxIgnoreUnreadFields(boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="getCacheTransactionManager--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheTransactionManager</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/CacheTransactionManager.html" title="interface in com.gemstone.gemfire.cache">CacheTransactionManager</a> getCacheTransactionManager()</pre> +<div class="block">Get the CacheTransactionManager instance for this Cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The CacheTransactionManager instance.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../com/gemstone/gemfire/cache/CacheClosedException.html" title="class in com.gemstone.gemfire.cache">CacheClosedException</a></code> - if the cache is closed.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.0</dd> +</dl> +</li> +</ul> +<a name="getJNDIContext--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJNDIContext</h4> +<pre>javax.naming.Context getJNDIContext()</pre> +<div class="block">Returns the JNDI context associated with the Cache.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>javax.naming.Context + Added as part of providing JTA implementation in Gemfire.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.0</dd> +</dl> +</li> +</ul> +<a name="getInitializer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitializer</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/Declarable.html" title="interface in com.gemstone.gemfire.cache">Declarable</a> getInitializer()</pre> +<div class="block">Returns the Declarable used to initialize this cache or <code>null</code> + if it does not have an initializer.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</dd> +</dl> +</li> +</ul> +<a name="getInitializerProps--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInitializerProps</h4> +<pre>java.util.Properties getInitializerProps()</pre> +<div class="block">Returns the Properties used to initialize the cache initializer or + <code>null</code> if no initializer properties exist.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.6</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/GatewayException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/IncompatibleVersionException.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/GemFireCache.html" target="_top">Frames</a></li> +<li><a href="GemFireCache.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/IncompatibleVersionException.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/IncompatibleVersionException.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/IncompatibleVersionException.html new file mode 100644 index 0000000..edfe29a --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/IncompatibleVersionException.html @@ -0,0 +1,310 @@ +<!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>IncompatibleVersionException (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="IncompatibleVersionException (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/GemFireCache.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.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/IncompatibleVersionException.html" target="_top">Frames</a></li> +<li><a href="IncompatibleVersionException.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.GemFireCheckedException">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 IncompatibleVersionException" class="title">Class IncompatibleVersionException</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><a href="../../../../com/gemstone/gemfire/GemFireCheckedException.html" title="class in com.gemstone.gemfire">com.gemstone.gemfire.GemFireCheckedException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/gemstone/gemfire/cache/VersionException.html" title="class in com.gemstone.gemfire.cache">com.gemstone.gemfire.cache.VersionException</a></li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.IncompatibleVersionException</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">IncompatibleVersionException</span> +extends <a href="../../../../com/gemstone/gemfire/cache/VersionException.html" title="class in com.gemstone.gemfire.cache">VersionException</a></pre> +<div class="block">An <code>IncompatibleVersionException</code> that the client version + was not compatible with the server version.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.IncompatibleVersionException">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/IncompatibleVersionException.html#IncompatibleVersionException-java.lang.Object-java.lang.Object-">IncompatibleVersionException</a></span>(java.lang.Object clientVersion, + java.lang.Object serverVersion)</code> +<div class="block">Constructs a new <code>IncompatibleVersionException</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/IncompatibleVersionException.html#IncompatibleVersionException-java.lang.String-">IncompatibleVersionException</a></span>(java.lang.String message)</code> +<div class="block">Constructs a new <code>IncompatibleVersionException</code>.</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.GemFireCheckedException"> +<!-- --> +</a> +<h3>Methods inherited from class com.gemstone.gemfire.<a href="../../../../com/gemstone/gemfire/GemFireCheckedException.html" title="class in com.gemstone.gemfire">GemFireCheckedException</a></h3> +<code><a href="../../../../com/gemstone/gemfire/GemFireCheckedException.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, toString</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="IncompatibleVersionException-java.lang.Object-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IncompatibleVersionException</h4> +<pre>public IncompatibleVersionException(java.lang.Object clientVersion, + java.lang.Object serverVersion)</pre> +<div class="block">Constructs a new <code>IncompatibleVersionException</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clientVersion</code> - The client <code>Version</code></dd> +<dd><code>serverVersion</code> - The server <code>Version</code></dd> +</dl> +</li> +</ul> +<a name="IncompatibleVersionException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IncompatibleVersionException</h4> +<pre>public IncompatibleVersionException(java.lang.String message)</pre> +<div class="block">Constructs a new <code>IncompatibleVersionException</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - The exception message</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/GemFireCache.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.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/IncompatibleVersionException.html" target="_top">Frames</a></li> +<li><a href="IncompatibleVersionException.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.GemFireCheckedException">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/InterestPolicy.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/InterestPolicy.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/InterestPolicy.html new file mode 100644 index 0000000..fdc681d --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/InterestPolicy.html @@ -0,0 +1,461 @@ +<!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>InterestPolicy (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="InterestPolicy (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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/IncompatibleVersionException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.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/InterestPolicy.html" target="_top">Frames</a></li> +<li><a href="InterestPolicy.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 InterestPolicy" class="title">Class InterestPolicy</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.InterestPolicy</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">InterestPolicy</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">Enumerated type for region subscription interest policy. + The interest policy specifies what data a subscriber is interested in having + in it's region.</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/SubscriptionAttributes.html" title="class in com.gemstone.gemfire.cache"><code>SubscriptionAttributes</code></a>, +<a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.InterestPolicy">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/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#ALL">ALL</a></span></code> +<div class="block">This subscriber is interested in all data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#CACHE_CONTENT">CACHE_CONTENT</a></span></code> +<div class="block">This subscriber is interested in data that is already in its cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#DEFAULT">DEFAULT</a></span></code> +<div class="block">The interest policy used by default; it is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</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/InterestPolicy.html#ordinal">ordinal</a></span></code> +<div class="block">used as ordinal to represent this InterestPolicy</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></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/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#fromOrdinal-byte-">fromOrdinal</a></span>(byte ordinal)</code> +<div class="block">Return the InterestPolicy 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/InterestPolicy.html#isAll--">isAll</a></span>()</code> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#ALL"><code>ALL</code></a>.</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/InterestPolicy.html#isCacheContent--">isCacheContent</a></span>()</code> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</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/InterestPolicy.html#isDefault--">isDefault</a></span>()</code> +<div class="block">Return true if this policy is the default.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string representation for this interest policy.</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="ALL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ALL</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a> ALL</pre> +<div class="block">This subscriber is interested in all data. + More specifically operations done in this cache and + distributed operations done in remote caches. + <p> + When combined with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#EMPTY"><code>DataPolicy.EMPTY</code></a> this region will receive + events for every distributed operation but will not store the data. + <p> + When combined with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a> or + <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED"><code>DataPolicy.PRELOADED</code></a> this region will accept + <a href="../../../../com/gemstone/gemfire/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a> operations done remotely. Without + the <code>ALL</code> interest policy, <code>NORMAL</code> and + <code>PRELOADED</code> ignore <code>creates</code> that the region + does not have an existing entry for. + <p> + When combined with the <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withReplication--"><code>replication + policies</code></a> this interest has no effect. + <p> + When combined with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a> this interest policy + causes cache listeners to be notified of changes regardless of the + physical location of the data affected. That is, a listener in a VM + using this policy will receive notification of all changes to the + partitioned region.</div> +</li> +</ul> +<a name="CACHE_CONTENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CACHE_CONTENT</h4> +<pre>public static final <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a> CACHE_CONTENT</pre> +<div class="block">This subscriber is interested in data that is already in its cache. + More specifically operations done in this cache and + distributed operations done in remote caches. + <p> + When combined with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#EMPTY"><code>DataPolicy.EMPTY</code></a> this region will never + receive events for distributed operations since its content is always + empty. It will continue to get events for operations done locally. + <p> + When combined with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a> or + <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PRELOADED"><code>DataPolicy.PRELOADED</code></a> this region will accept remote operations + done to entries it already has in its cache. + <p> + When combined with the <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#withReplication--"><code>replication + policies</code></a> * this interest has no effect. + <p> + When combined with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a> this interest policy + causes cache listeners to be notified in the VM holding the affected data. + That is, listeners are only notified if the affected* key-value pair is + in the same process as the listener.</div> +</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/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a> DEFAULT</pre> +<div class="block">The interest policy used by default; it is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</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 InterestPolicy</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/InterestPolicy.html" title="class in com.gemstone.gemfire.cache">InterestPolicy</a> fromOrdinal(byte ordinal)</pre> +<div class="block">Return the InterestPolicy represented by specified ordinal</div> +</li> +</ul> +<a name="isAll--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAll</h4> +<pre>public boolean isAll()</pre> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#ALL"><code>ALL</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#ALL"><code>ALL</code></a>.</dd> +</dl> +</li> +</ul> +<a name="isCacheContent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCacheContent</h4> +<pre>public boolean isCacheContent()</pre> +<div class="block">Return true if this policy is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this policy is <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</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">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="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 interest 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 interest 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/IncompatibleVersionException.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.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/InterestPolicy.html" target="_top">Frames</a></li> +<li><a href="InterestPolicy.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/InterestRegistrationEvent.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/InterestRegistrationEvent.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/InterestRegistrationEvent.html new file mode 100644 index 0000000..f84a377 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/InterestRegistrationEvent.html @@ -0,0 +1,378 @@ +<!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>InterestRegistrationEvent (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="InterestRegistrationEvent (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/InterestPolicy.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationListener.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/InterestRegistrationEvent.html" target="_top">Frames</a></li> +<li><a href="InterestRegistrationEvent.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 InterestRegistrationEvent" class="title">Interface InterestRegistrationEvent</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">InterestRegistrationEvent</span></pre> +<div class="block">Interface <code>InterestRegistrationEvent</code> encapsulated interest + event information like region and keys of interest.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.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><a href="../../../../com/gemstone/gemfire/cache/ClientSession.html" title="interface in com.gemstone.gemfire.cache">ClientSession</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.html#getClientSession--">getClientSession</a></span>()</code> +<div class="block">Returns the <a href="../../../../com/gemstone/gemfire/cache/ClientSession.html" title="interface in com.gemstone.gemfire.cache"><code>ClientSession</code></a> that initiated this event</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.html#getInterestType--">getInterestType</a></span>()</code> +<div class="block">Returns this event's interest type.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.util.Set<?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.html#getKeysOfInterest--">getKeysOfInterest</a></span>()</code> +<div class="block">Returns a <code>Set</code> of keys of interest.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/Region.html" title="interface in com.gemstone.gemfire.cache">Region</a><?,?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.html#getRegion--">getRegion</a></span>()</code> +<div class="block">Returns the region to which this interest belongs.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationEvent.html#getRegionName--">getRegionName</a></span>()</code> +<div class="block">Returns the name of the region to which this interest event belongs.</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/InterestRegistrationEvent.html#isKey--">isKey</a></span>()</code> +<div class="block">Returns whether this event's interest type is + <code>InterestType.KEY</code>.</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/InterestRegistrationEvent.html#isRegister--">isRegister</a></span>()</code> +<div class="block">Returns whether this event represents a register interest.</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/InterestRegistrationEvent.html#isRegularExpression--">isRegularExpression</a></span>()</code> +<div class="block">Returns whether this event's interest type is + <code>InterestType.REGULAR_EXPRESSION</code>.</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="getRegionName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegionName</h4> +<pre>java.lang.String getRegionName()</pre> +<div class="block">Returns the name of the region to which this interest event belongs.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the name of the region to which this interest event belongs</dd> +</dl> +</li> +</ul> +<a name="getRegion--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegion</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/Region.html" title="interface in com.gemstone.gemfire.cache">Region</a><?,?> getRegion()</pre> +<div class="block">Returns the region to which this interest belongs.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the region to which this interest belongs</dd> +</dl> +</li> +</ul> +<a name="getKeysOfInterest--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeysOfInterest</h4> +<pre>java.util.Set<?> getKeysOfInterest()</pre> +<div class="block">Returns a <code>Set</code> of keys of interest.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>Set</code> of keys of interest</dd> +</dl> +</li> +</ul> +<a name="getInterestType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInterestType</h4> +<pre>int getInterestType()</pre> +<div class="block">Returns this event's interest type.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this event's interest type</dd> +</dl> +</li> +</ul> +<a name="isRegister--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRegister</h4> +<pre>boolean isRegister()</pre> +<div class="block">Returns whether this event represents a register interest.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this event represents a register interest</dd> +</dl> +</li> +</ul> +<a name="isKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isKey</h4> +<pre>boolean isKey()</pre> +<div class="block">Returns whether this event's interest type is + <code>InterestType.KEY</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this event's interest type is + <code>InterestType.KEY</code></dd> +</dl> +</li> +</ul> +<a name="isRegularExpression--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRegularExpression</h4> +<pre>boolean isRegularExpression()</pre> +<div class="block">Returns whether this event's interest type is + <code>InterestType.REGULAR_EXPRESSION</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this event's interest type is + <code>InterestType.REGULAR_EXPRESSION</code></dd> +</dl> +</li> +</ul> +<a name="getClientSession--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getClientSession</h4> +<pre><a href="../../../../com/gemstone/gemfire/cache/ClientSession.html" title="interface in com.gemstone.gemfire.cache">ClientSession</a> getClientSession()</pre> +<div class="block">Returns the <a href="../../../../com/gemstone/gemfire/cache/ClientSession.html" title="interface in com.gemstone.gemfire.cache"><code>ClientSession</code></a> that initiated this event</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../com/gemstone/gemfire/cache/ClientSession.html" title="interface in com.gemstone.gemfire.cache"><code>ClientSession</code></a> that initiated this event</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/InterestPolicy.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/InterestRegistrationListener.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/InterestRegistrationEvent.html" target="_top">Frames</a></li> +<li><a href="InterestRegistrationEvent.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>