http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html new file mode 100644 index 0000000..72914ba --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionFactory.html @@ -0,0 +1,697 @@ +<!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 Sat Oct 15 16:23:28 PDT 2016 --> +<title>DynamicRegionFactory (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="DynamicRegionFactory (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":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="../../../../org/apache/geode/cache/DuplicatePrimaryPartitionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/DynamicRegionFactory.html" target="_top">Frames</a></li> +<li><a href="DynamicRegionFactory.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">org.apache.geode.cache</div> +<h2 title="Class DynamicRegionFactory" class="title">Class DynamicRegionFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.cache.DynamicRegionFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">DynamicRegionFactory</span> +extends java.lang.Object</pre> +<div class="block">DynamicRegionFactory provides a distributed region creation service. + Any other member of the GemFire DistributedSystem that has created + an instance of this class will automatically instantiate regions created + through the factory from anywhere else in the DistributedSystem. + <p><p> + Instructions for Use:<br> + <ul> + <li> If your application is a client in a client/server installation, + either specify the pool name in the + <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache"><code>DynamicRegionFactory.Config</code></a> you'll use to create a + DynamicRegionFactory <i>or</i> specify it + in a dynamic-region-factory element in your cache.xml. + + <li> Before you've created a GemFire Cache in your application, add a + line of code as follows:<br> + <pre><code> DynamicRegionFactory factory = DynamicRegionFactory.get(); + factory.open(config);</code></pre> + <pre><code> DynamicRegionFactory myFactoryHandle = DynamicRegionFactory.get().open(config);</code></pre> + or just use a dynamic-region-factory element in the cache.xml. + + <li> Create the GemFire Cache. During cache creation, the list of dynamic Regions will either be discovered + by recovering + their names from disk (see <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#persistBackup"><code>DynamicRegionFactory.Config.persistBackup</code></a>) or from other members of the + distributed system. + These dynamic Regions will be created before Cache creation completes. + + <li> Thereafter, when you want to create dynamic distributed Regions, + create them using the <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#createDynamicRegion-java.lang.String-java.lang.String-"><code>createDynamicRegion(java.lang.String, java.lang.String)</code></a>. Regions created with the factory will + inherit their RegionAttributes from their parent Region, though you can override + callbacks when you configure the factory. + + <p>All other instances of GemFire across the distributed system that + instantiate and open a DynamicRegionFactory will also get the dynamic distributed Regions. + + <li>Non-dynamic parent Regions should be declared in cache.xml so that they can be created before + the dynamic Region factory goes active and starts creating Regions. You will have cache creation + problems if this isn't done. + + <li>A DynamicRegionListener can be registered before open is called and before cache creation + so that the listener will be called if dynamic Regions are created during cache creation. + + </ul> + <p>Saving the factory on disk: + If <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#persistBackup"><code>DynamicRegionFactory.Config.persistBackup</code></a> is configured for the factory, dynamic Region information + is written to disk for recovery. + By default the current directory is used for this information. The <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#diskDir"><code>DynamicRegionFactory.Config.diskDir</code></a> + can be used to change this default. + <p> + Registering interest in cache server information: The <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html#registerInterest"><code>DynamicRegionFactory.Config.registerInterest</code></a> + setting determines whether clients will register interest in server keys or not. You will generally want + this to be turned on so that clients will see updates made to servers. In server processes, DynamicRegionFactory + forces use of NotifyBySubscription. + </ul> + <p> + Notes: + <ul> + <li>DynamicRegionFactories in non-client VMs must not be configured with a pool. + <li>If <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#open--"><code>open()</code></a> is called before cache creation and the cache.xml has a dynamic-region-factory + element then the cache.xml will override the open call's configuration. + + <li>Since the RegionAttributes of a dynamically created Region are copied + from the parent Region, any callbacks, (<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache"><code>CacheListener</code></a>, + <a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache"><code>CacheWriter</code></a>, and <a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache"><code>CacheLoader</code></a> + are shared by the parent and all its dynamic children + so make sure the callback is thread-safe and that its + <a href="../../../../org/apache/geode/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> implementation does not stop it from functioning. + However the products LRUAlgorithm instances will + be cloned so that each dynamic Region has its own callback. + + <li>The root Region name "DynamicRegions" is reserved. The factory creates a root Region of + that name and uses it to keep track of what dynamic Regions exist. Applications should + not directly access this Region; instead use the methods on this factory. + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.3</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a></span></code> +<div class="block">Configuration for dynamic region factory.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== 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 java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#dynamicRegionListName">dynamicRegionListName</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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="../../../../org/apache/geode/cache/DynamicRegionFactory.html#DynamicRegionFactory--">DynamicRegionFactory</a></span>()</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="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>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#Z:Z_close--">_close</a></span>()</code> +<div class="block">Closes the dynamic region factory, disabling any further creation or + destruction of dynamic regions in this cache.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#Z:Z_internalInit-org.apache.geode.internal.cache.GemFireCacheImpl-">_internalInit</a></span>(org.apache.geode.internal.cache.GemFireCacheImpl theCache)</code> +<div class="block">The method is for internal use only.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#buildDynamicRegion-org.apache.geode.cache.EntryEvent-">buildDynamicRegion</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a> event)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#createDynamicRegion-java.lang.String-java.lang.String-">createDynamicRegion</a></span>(java.lang.String parentRegionName, + java.lang.String regionName)</code> +<div class="block">Creates the dynamic Region in the local cache and distributes the + creation to other caches.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#destroyDynamicRegion-java.lang.String-">destroyDynamicRegion</a></span>(java.lang.String fullRegionName)</code> +<div class="block">Destroys the dynamic Region in the local cache and distributes the + destruction to other caches.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html" title="class in org.apache.geode.cache">DynamicRegionFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#get--">get</a></span>()</code> +<div class="block">Returns the <code>DynamicRegionFactory</code> singleton instance.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#getConfig--">getConfig</a></span>()</code> +<div class="block">Returns the configuration for this factory.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#isActive--">isActive</a></span>()</code> +<div class="block">Returns true if this factory is open and can produce dynamic regions.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#isClosed--">isClosed</a></span>()</code> +<div class="block">Returns true if dynamic region factory is closed.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#isOpen--">isOpen</a></span>()</code> +<div class="block">Returns true if dynamic region factory is open; false if closed.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#open--">open</a></span>()</code> +<div class="block">Opens the DynamicRegionFactory with default settings.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#open-org.apache.geode.cache.DynamicRegionFactory.Config-">open</a></span>(<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a> conf)</code> +<div class="block">Opens the factory with the given settings.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#razeDynamicRegion-org.apache.geode.cache.EntryEvent-">razeDynamicRegion</a></span>(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a> event)</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#regionIsDynamicRegionList-java.lang.String-">regionIsDynamicRegionList</a></span>(java.lang.String regionPath)</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#registerDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-">registerDynamicRegionListener</a></span>(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a> listener)</code> +<div class="block">Registers a <code>DynamicRegionListener</code> for callbacks.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html#unregisterDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-">unregisterDynamicRegionListener</a></span>(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a> listener)</code> +<div class="block">Unregisters a <code>DynamicRegionListener</code> for callbacks.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="dynamicRegionListName"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>dynamicRegionListName</h4> +<pre>public static final java.lang.String dynamicRegionListName</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DynamicRegionFactory.dynamicRegionListName">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DynamicRegionFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DynamicRegionFactory</h4> +<pre>public DynamicRegionFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="open--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>open</h4> +<pre>public void open()</pre> +<div class="block">Opens the DynamicRegionFactory with default settings.</div> +</li> +</ul> +<a name="open-org.apache.geode.cache.DynamicRegionFactory.Config-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>open</h4> +<pre>public void open(<a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a> conf)</pre> +<div class="block">Opens the factory with the given settings. + This should be sent to the factory before creating a cache. The cache + will otherwise open a factory with default settings. + This does not need to be sent if the cache.xml declares the use of dynamic regions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conf</code> - the configuration for this factory.</dd> +</dl> +</li> +</ul> +<a name="Z:Z_close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>_close</h4> +<pre>protected void _close()</pre> +<div class="block">Closes the dynamic region factory, disabling any further creation or + destruction of dynamic regions in this cache.</div> +</li> +</ul> +<a name="isOpen--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOpen</h4> +<pre>public boolean isOpen()</pre> +<div class="block">Returns true if dynamic region factory is open; false if closed.</div> +</li> +</ul> +<a name="isActive--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isActive</h4> +<pre>public boolean isActive()</pre> +<div class="block">Returns true if this factory is open and can produce dynamic regions. + Factories are only active after their cache has been created.</div> +</li> +</ul> +<a name="isClosed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +<div class="block">Returns true if dynamic region factory is closed.</div> +</li> +</ul> +<a name="getConfig--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfig</h4> +<pre>public <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache">DynamicRegionFactory.Config</a> getConfig()</pre> +<div class="block">Returns the configuration for this factory. + Returns null if the factory is closed;</div> +</li> +</ul> +<a name="regionIsDynamicRegionList-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>regionIsDynamicRegionList</h4> +<pre>public static boolean regionIsDynamicRegionList(java.lang.String regionPath)</pre> +</li> +</ul> +<a name="Z:Z_internalInit-org.apache.geode.internal.cache.GemFireCacheImpl-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>_internalInit</h4> +<pre>protected void _internalInit(org.apache.geode.internal.cache.GemFireCacheImpl theCache) + throws <a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></pre> +<div class="block">The method is for internal use only. It is called implicitly during cache creation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>theCache</code> - The GemFire <code>Cache</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code></dd> +</dl> +</li> +</ul> +<a name="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html" title="class in org.apache.geode.cache">DynamicRegionFactory</a> get()</pre> +<div class="block">Returns the <code>DynamicRegionFactory</code> singleton instance.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <code>DynamicRegionFactory</code> singleton instance</dd> +</dl> +</li> +</ul> +<a name="registerDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerDynamicRegionListener</h4> +<pre>public void registerDynamicRegionListener(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a> listener)</pre> +<div class="block">Registers a <code>DynamicRegionListener</code> for callbacks.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - The <code>DynamicRegionListener</code> to be registered</dd> +</dl> +</li> +</ul> +<a name="unregisterDynamicRegionListener-org.apache.geode.cache.DynamicRegionListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unregisterDynamicRegionListener</h4> +<pre>public void unregisterDynamicRegionListener(<a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache">DynamicRegionListener</a> listener)</pre> +<div class="block">Unregisters a <code>DynamicRegionListener</code> for callbacks.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - The <code>DynamicRegionListener</code> to be unregistered</dd> +</dl> +</li> +</ul> +<a name="createDynamicRegion-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDynamicRegion</h4> +<pre>public <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a> createDynamicRegion(java.lang.String parentRegionName, + java.lang.String regionName) + throws <a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></pre> +<div class="block">Creates the dynamic Region in the local cache and distributes the + creation to other caches.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parentRegionName</code> - the new region is created as a subregion of the region having this path</dd> +<dd><code>regionName</code> - the name of the new subregion</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <code>Region</code> created</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code></dd> +</dl> +</li> +</ul> +<a name="destroyDynamicRegion-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>destroyDynamicRegion</h4> +<pre>public void destroyDynamicRegion(java.lang.String fullRegionName) + throws <a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></pre> +<div class="block">Destroys the dynamic Region in the local cache and distributes the + destruction to other caches.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fullRegionName</code> - The full path of the <code>Region</code> to be + dynamically destroyed</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code></dd> +<dd><code><a href="../../../../org/apache/geode/cache/RegionDestroyedException.html" title="class in org.apache.geode.cache">RegionDestroyedException</a></code> - if the dynamic region was never created + or has already been destroyed</dd> +</dl> +</li> +</ul> +<a name="buildDynamicRegion-org.apache.geode.cache.EntryEvent-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildDynamicRegion</h4> +<pre>protected void buildDynamicRegion(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a> event)</pre> +</li> +</ul> +<a name="razeDynamicRegion-org.apache.geode.cache.EntryEvent-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>razeDynamicRegion</h4> +<pre>protected void razeDynamicRegion(<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a> event)</pre> +</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="../../../../org/apache/geode/cache/DuplicatePrimaryPartitionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/DynamicRegionFactory.html" target="_top">Frames</a></li> +<li><a href="DynamicRegionFactory.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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/8888a496/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html new file mode 100644 index 0000000..fe7e30e --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DynamicRegionListener.html @@ -0,0 +1,308 @@ +<!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 Sat Oct 15 16:23:28 PDT 2016 --> +<title>DynamicRegionListener (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="DynamicRegionListener (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/EntryDestroyedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/DynamicRegionListener.html" target="_top">Frames</a></li> +<li><a href="DynamicRegionListener.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">org.apache.geode.cache</div> +<h2 title="Interface DynamicRegionListener" class="title">Interface DynamicRegionListener</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DynamicRegionListener</span></pre> +<div class="block"><code>DynamicRegionListener</code> is an interface that can be + implemented to handle dynamic region-related events. + + The methods on a <code>DynamicRegionListener</code> are invoked synchronously. + If the listener method takes a long time to execute then it will cause the + operation that caused it to be invoked to take a long time. + <p> + Note: It is possible to receive duplicate create events when the DynamicRegionFactory + goes active due to Cache creation. + <p> + See <a href="../../../../org/apache/geode/cache/DynamicRegionFactory.html" title="class in org.apache.geode.cache"><code>DynamicRegionFactory</code></a></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.3</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="../../../../org/apache/geode/cache/DynamicRegionListener.html#afterRegionCreate-org.apache.geode.cache.RegionEvent-">afterRegionCreate</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><?,?> event)</code> +<div class="block">Handles the 'after region creation' event of a dynamic region.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionListener.html#afterRegionDestroy-org.apache.geode.cache.RegionEvent-">afterRegionDestroy</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><?,?> event)</code> +<div class="block">Handles the 'after region destroyed' event of a dynamic region.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionListener.html#beforeRegionCreate-java.lang.String-java.lang.String-">beforeRegionCreate</a></span>(java.lang.String parentRegionName, + java.lang.String regionName)</code> +<div class="block">Handles the 'before region creation' event of a dynamic region.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DynamicRegionListener.html#beforeRegionDestroy-org.apache.geode.cache.RegionEvent-">beforeRegionDestroy</a></span>(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><?,?> event)</code> +<div class="block">Handles the 'before region destroyed' event of a dynamic region.</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="beforeRegionCreate-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeRegionCreate</h4> +<pre>void beforeRegionCreate(java.lang.String parentRegionName, + java.lang.String regionName)</pre> +<div class="block">Handles the 'before region creation' event of a dynamic region. This method + is invoked before the dynamic region is created in the local VM.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parentRegionName</code> - The name of the parent region</dd> +<dd><code>regionName</code> - The name of the region being created</dd> +</dl> +</li> +</ul> +<a name="afterRegionCreate-org.apache.geode.cache.RegionEvent-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterRegionCreate</h4> +<pre>void afterRegionCreate(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><?,?> event)</pre> +<div class="block">Handles the 'after region creation' event of a dynamic region. This method + is invoked after the dynamic region is created in the local VM.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>event</code> - A <code>RegionEvent</code> describing the event</dd> +</dl> +</li> +</ul> +<a name="beforeRegionDestroy-org.apache.geode.cache.RegionEvent-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeRegionDestroy</h4> +<pre>void beforeRegionDestroy(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><?,?> event)</pre> +<div class="block">Handles the 'before region destroyed' event of a dynamic region. This method + is invoked before the dynamic region is destroyed in the local VM.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>event</code> - A <code>RegionEvent</code> describing the event</dd> +</dl> +</li> +</ul> +<a name="afterRegionDestroy-org.apache.geode.cache.RegionEvent-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>afterRegionDestroy</h4> +<pre>void afterRegionDestroy(<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><?,?> event)</pre> +<div class="block">Handles the 'after region destroyed' event of a dynamic region. This method + is invoked after the dynamic region is destroyed in the local VM.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>event</code> - A <code>RegionEvent</code> describing the 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="../../../../org/apache/geode/cache/DynamicRegionFactory.Config.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/EntryDestroyedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/DynamicRegionListener.html" target="_top">Frames</a></li> +<li><a href="DynamicRegionListener.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/8888a496/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html b/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html new file mode 100644 index 0000000..28a5a34 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/EntryDestroyedException.html @@ -0,0 +1,358 @@ +<!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 Sat Oct 15 16:23:28 PDT 2016 --> +<title>EntryDestroyedException (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="EntryDestroyedException (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + 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="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/EntryDestroyedException.html" target="_top">Frames</a></li> +<li><a href="EntryDestroyedException.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.org.apache.geode.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.geode.cache</div> +<h2 title="Class EntryDestroyedException" class="title">Class EntryDestroyedException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">org.apache.geode.GemFireException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache">org.apache.geode.cache.CacheRuntimeException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.geode.cache.EntryDestroyedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">EntryDestroyedException</span> +extends <a href="../../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache">CacheRuntimeException</a></pre> +<div class="block">Indicates that a method was invoked on an entry that has been destroyed.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/Region.Entry.html" title="interface in org.apache.geode.cache"><code>Region.Entry</code></a>, +<a href="../../../../serialized-form.html#org.apache.geode.cache.EntryDestroyedException">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="../../../../org/apache/geode/cache/EntryDestroyedException.html#EntryDestroyedException--">EntryDestroyedException</a></span>()</code> +<div class="block">Constructs a new <code>EntryDestroyedException</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryDestroyedException.html#EntryDestroyedException-java.lang.String-">EntryDestroyedException</a></span>(java.lang.String s)</code> +<div class="block">Constructs a new <code>EntryDestroyedException</code> with the message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryDestroyedException.html#EntryDestroyedException-java.lang.String-java.lang.Throwable-">EntryDestroyedException</a></span>(java.lang.String s, + java.lang.Throwable ex)</code> +<div class="block">Constructs a new <code>EntryDestroyedException</code> with a detailed message + and a causal exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryDestroyedException.html#EntryDestroyedException-java.lang.Throwable-">EntryDestroyedException</a></span>(java.lang.Throwable ex)</code> +<div class="block">Construct a <code>EntryDestroyedException</code> with a cause.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.CacheRuntimeException"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/CacheRuntimeException.html" title="class in org.apache.geode.cache">CacheRuntimeException</a></h3> +<code><a href="../../../../org/apache/geode/cache/CacheRuntimeException.html#toString--">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.GemFireException"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.geode.<a href="../../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></h3> +<code><a href="../../../../org/apache/geode/GemFireException.html#getRootCause--">getRootCause</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="EntryDestroyedException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EntryDestroyedException</h4> +<pre>public EntryDestroyedException()</pre> +<div class="block">Constructs a new <code>EntryDestroyedException</code>.</div> +</li> +</ul> +<a name="EntryDestroyedException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EntryDestroyedException</h4> +<pre>public EntryDestroyedException(java.lang.String s)</pre> +<div class="block">Constructs a new <code>EntryDestroyedException</code> with the message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - the detailed message for this exception</dd> +</dl> +</li> +</ul> +<a name="EntryDestroyedException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EntryDestroyedException</h4> +<pre>public EntryDestroyedException(java.lang.String s, + java.lang.Throwable ex)</pre> +<div class="block">Constructs a new <code>EntryDestroyedException</code> with a detailed message + and a causal exception.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>s</code> - the message</dd> +<dd><code>ex</code> - a causal Throwable</dd> +</dl> +</li> +</ul> +<a name="EntryDestroyedException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EntryDestroyedException</h4> +<pre>public EntryDestroyedException(java.lang.Throwable ex)</pre> +<div class="block">Construct a <code>EntryDestroyedException</code> with a cause.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ex</code> - the causal Throwable</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/geode/cache/DynamicRegionListener.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/EntryDestroyedException.html" target="_top">Frames</a></li> +<li><a href="EntryDestroyedException.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.org.apache.geode.cache.CacheRuntimeException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html b/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html new file mode 100644 index 0000000..108d412 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html @@ -0,0 +1,562 @@ +<!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 Sat Oct 15 16:23:28 PDT 2016 --> +<title>EntryEvent (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="EntryEvent (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":38,"i8":38,"i9":38,"i10":38,"i11":38,"i12":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../org/apache/geode/cache/EntryDestroyedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/EntryExistsException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/EntryEvent.html" target="_top">Frames</a></li> +<li><a href="EntryEvent.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">org.apache.geode.cache</div> +<h2 title="Interface EntryEvent" class="title">Interface EntryEvent<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/geode/cache/CacheEvent.html" title="interface in org.apache.geode.cache">CacheEvent</a><K,V></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/geode/cache/util/TimestampedEntryEvent.html" title="interface in org.apache.geode.cache.util">TimestampedEntryEvent</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">EntryEvent<K,V></span> +extends <a href="../../../../org/apache/geode/cache/CacheEvent.html" title="interface in org.apache.geode.cache">CacheEvent</a><K,V></pre> +<div class="block">Contains information about an event affecting an entry, including + its identity and the the circumstances of the event. + It is passed in to <code>CacheListener</code>, <code>CapacityController</code>, and <code>CacheWriter</code>. + <p> + If this event originated from a region stored off heap then this event can + only be used as long as the notification method that obtained it has not returned. + For example in your implementation of <a href="../../../../org/apache/geode/cache/CacheListener.html#afterUpdate-org.apache.geode.cache.EntryEvent-"><code>CacheListener.afterUpdate(EntryEvent)</code></a> the event parameter + is only valid until your afterUpdate method returns. It is not safe to store instances of this + class and use them later when using off heap storage. + Attempts to access off-heap data from this event after it has expired will result in an + IllegalStateException.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache"><code>CacheListener</code></a>, +<a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache"><code>CacheWriter</code></a>, +<a href="../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache"><code>RegionEvent</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><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><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">K</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#getKey--">getKey</a></span>()</code> +<div class="block">Returns the key.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#getNewValue--">getNewValue</a></span>()</code> +<div class="block">Returns the value in the cache after this event.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#getOldValue--">getOldValue</a></span>()</code> +<div class="block">Returns the value in the cache prior to this event.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/SerializedCacheValue.html" title="interface in org.apache.geode.cache">SerializedCacheValue</a><<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#getSerializedNewValue--">getSerializedNewValue</a></span>()</code> +<div class="block">Returns the serialized form of the value in the cache after this event.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/SerializedCacheValue.html" title="interface in org.apache.geode.cache">SerializedCacheValue</a><<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#getSerializedOldValue--">getSerializedOldValue</a></span>()</code> +<div class="block">Returns the serialized form of the value in the cache before this event.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/TransactionId.html" title="interface in org.apache.geode.cache">TransactionId</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#getTransactionId--">getTransactionId</a></span>()</code> +<div class="block">Gets the TransactionId for this EntryEvent.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#hasClientOrigin--">hasClientOrigin</a></span>()</code> +<div class="block">Returns true if this event originated on a client.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#isBridgeEvent--">isBridgeEvent</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 5.7 use <a href="../../../../org/apache/geode/cache/EntryEvent.html#hasClientOrigin--"><code>hasClientOrigin()</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#isLoad--">isLoad</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isLoad--"><code>Operation.isLoad()</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#isLocalLoad--">isLocalLoad</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isLocalLoad--"><code>Operation.isLocalLoad()</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#isNetLoad--">isNetLoad</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isNetLoad--"><code>Operation.isNetLoad()</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#isNetSearch--">isNetSearch</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isNetSearch--"><code>Operation.isNetSearch()</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/EntryEvent.html#isOldValueAvailable--">isOldValueAvailable</a></span>()</code> +<div class="block">Returns <code>true</code> if the old value is "available".</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.CacheEvent"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.geode.cache.<a href="../../../../org/apache/geode/cache/CacheEvent.html" title="interface in org.apache.geode.cache">CacheEvent</a></h3> +<code><a href="../../../../org/apache/geode/cache/CacheEvent.html#getCallbackArgument--">getCallbackArgument</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#getDistributedMember--">getDistributedMember</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#getOperation--">getOperation</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#getRegion--">getRegion</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#isCallbackArgumentAvailable--">isCallbackArgumentAvailable</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#isDistributed--">isDistributed</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#isExpiration--">isExpiration</a>, <a href="../../../../org/apache/geode/cache/CacheEvent.html#isOriginRemote--">isOriginRemote</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="getKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKey</h4> +<pre><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">K</a> getKey()</pre> +<div class="block">Returns the key.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the key</dd> +</dl> +</li> +</ul> +<a name="getOldValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOldValue</h4> +<pre><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a> getOldValue()</pre> +<div class="block">Returns the value in the cache prior to this event. + When passed to an event handler after an event occurs, this value + reflects the value that was in the cache in this VM, not necessarily + the value that was in the cache VM that initiated the operation. + In certain scenarios the old value may no longer be available in which + case <code>null</code> is returned. + This can happen for disk regions when the old value is on disk only.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the old value in the cache prior to this event. + If the entry did not exist, was invalid, or was not available, + then null is returned.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if off-heap and called after the method that was passed this EntryEvent returns.</dd> +</dl> +</li> +</ul> +<a name="getSerializedOldValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSerializedOldValue</h4> +<pre><a href="../../../../org/apache/geode/cache/SerializedCacheValue.html" title="interface in org.apache.geode.cache">SerializedCacheValue</a><<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a>> getSerializedOldValue()</pre> +<div class="block">Returns the serialized form of the value in the cache before this event.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the serialized form of the value in the cache before this event</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if off-heap and called after the method that was passed this EntryEvent returns.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.5</dd> +</dl> +</li> +</ul> +<a name="getNewValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNewValue</h4> +<pre><a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a> getNewValue()</pre> +<div class="block">Returns the value in the cache after this event.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the value in the cache after this event</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if off-heap and called after the method that was passed this EntryEvent returns.</dd> +</dl> +</li> +</ul> +<a name="getSerializedNewValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSerializedNewValue</h4> +<pre><a href="../../../../org/apache/geode/cache/SerializedCacheValue.html" title="interface in org.apache.geode.cache">SerializedCacheValue</a><<a href="../../../../org/apache/geode/cache/EntryEvent.html" title="type parameter in EntryEvent">V</a>> getSerializedNewValue()</pre> +<div class="block">Returns the serialized form of the value in the cache after this event.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the serialized form of the value in the cache after this event</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if off-heap and called after the method that was passed this EntryEvent returns.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.5</dd> +</dl> +</li> +</ul> +<a name="isLocalLoad--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLocalLoad</h4> +<pre>@Deprecated +boolean isLocalLoad()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isLocalLoad--"><code>Operation.isLocalLoad()</code></a> instead.</span></div> +<div class="block">Returns true if this event resulted from a loader running in this cache. + Note that this will be true even if the local loader called <code>netSearch</code>. + + If this event is for a Partitioned Region, then true will be returned if the + loader ran in the same VM as where the data is hosted. If true is returned, and <a href="../../../../org/apache/geode/cache/CacheEvent.html#isOriginRemote--"><code>CacheEvent.isOriginRemote()</code></a> + is true, it means the data is not hosted locally, but the loader was run local to the data.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this event resulted from local loader execution</dd> +</dl> +</li> +</ul> +<a name="isNetLoad--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNetLoad</h4> +<pre>@Deprecated +boolean isNetLoad()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isNetLoad--"><code>Operation.isNetLoad()</code></a> instead.</span></div> +<div class="block">Returns true if this event resulted from a loader running that was remote + from the cache that requested it, i.e., a netLoad. Note that the cache + that requested the netLoad may not be this cache in which case + <code>isOriginRemote</code> will also return true.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this event resulted from a netLoad</dd> +</dl> +</li> +</ul> +<a name="isLoad--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLoad</h4> +<pre>@Deprecated +boolean isLoad()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isLoad--"><code>Operation.isLoad()</code></a> instead.</span></div> +<div class="block">Returns true if this event resulted from a loader.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if isLocalLoad or isNetLoad</dd> +</dl> +</li> +</ul> +<a name="isNetSearch--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNetSearch</h4> +<pre>@Deprecated +boolean isNetSearch()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../org/apache/geode/cache/Operation.html#isNetSearch--"><code>Operation.isNetSearch()</code></a> instead.</span></div> +<div class="block">Returns true if this event resulted from a <code>netSearch</code>. If the <code>netSearch</code> + was invoked by a loader however, this will return false and <code>isLocalLoad()</code> + or <code>isNetLoad()</code> will return true instead.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this event resulted from a netSearch</dd> +</dl> +</li> +</ul> +<a name="getTransactionId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionId</h4> +<pre><a href="../../../../org/apache/geode/cache/TransactionId.html" title="interface in org.apache.geode.cache">TransactionId</a> getTransactionId()</pre> +<div class="block">Gets the TransactionId for this EntryEvent.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the ID of the transaction that performed the operation that + generated this event; null if no transaction involved.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 4.0</dd> +</dl> +</li> +</ul> +<a name="isBridgeEvent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBridgeEvent</h4> +<pre>@Deprecated +boolean isBridgeEvent()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 5.7 use <a href="../../../../org/apache/geode/cache/EntryEvent.html#hasClientOrigin--"><code>hasClientOrigin()</code></a> instead.</span></div> +<div class="block">Returns true if this event originated on a client.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this event originated on a client.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.1</dd> +</dl> +</li> +</ul> +<a name="hasClientOrigin--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasClientOrigin</h4> +<pre>boolean hasClientOrigin()</pre> +<div class="block">Returns true if this event originated on a client.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this event originated on a client.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 5.7</dd> +</dl> +</li> +</ul> +<a name="isOldValueAvailable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isOldValueAvailable</h4> +<pre>boolean isOldValueAvailable()</pre> +<div class="block">Returns <code>true</code> if the old value is "available". + Not available means that an old value existed but it could not be obtained + or it was deemed too expensive to obtain. + Note that <a href="../../../../org/apache/geode/cache/EntryEvent.html#getOldValue--"><code>getOldValue()</code></a> will return <code>null</code> when this + method returns <code>false</code>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 6.0</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="../../../../org/apache/geode/cache/EntryDestroyedException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/EntryExistsException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/geode/cache/EntryEvent.html" target="_top">Frames</a></li> +<li><a href="EntryEvent.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>
