| <!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 --> |
| <title>CacheWriterAdapter (Apache Geode 1.15.1)</title> |
| <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="CacheWriterAdapter (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/geode/cache/util/CacheListenerAdapter.html" title="class in org.apache.geode.cache.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/util/CqListenerAdapter.html" title="class in org.apache.geode.cache.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/util/CacheWriterAdapter.html" target="_top">Frames</a></li> |
| <li><a href="CacheWriterAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.cache.util</div> |
| <h2 title="Class CacheWriterAdapter" class="title">Class CacheWriterAdapter<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.cache.util.CacheWriterAdapter<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a>, <a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><K,V>, <a href="../../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache">Declarable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/geode/modules/session/catalina/callback/LocalSessionCacheWriter.html" title="class in org.apache.geode.modules.session.catalina.callback">LocalSessionCacheWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CacheWriterAdapter<K,V></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><K,V></pre> |
| <div class="block">Utility class that implements all methods in <code>CacheWriter</code> with empty implementations. |
| Applications can subclass this class and only override the methods for the events of interest.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html#CacheWriterAdapter--">CacheWriterAdapter</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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html#beforeCreate-org.apache.geode.cache.EntryEvent-">beforeCreate</a></span>(<a href="../../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event)</code> |
| <div class="block">Called before an entry is created.</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/util/CacheWriterAdapter.html#beforeDestroy-org.apache.geode.cache.EntryEvent-">beforeDestroy</a></span>(<a href="../../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event)</code> |
| <div class="block">Called before an entry is destroyed.</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/util/CacheWriterAdapter.html#beforeRegionClear-org.apache.geode.cache.RegionEvent-">beforeRegionClear</a></span>(<a href="../../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event)</code> |
| <div class="block">Called before a region is cleared.</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/util/CacheWriterAdapter.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><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event)</code> |
| <div class="block">Called before a region is destroyed.</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/util/CacheWriterAdapter.html#beforeUpdate-org.apache.geode.cache.EntryEvent-">beforeUpdate</a></span>(<a href="../../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event)</code> |
| <div class="block">Called before an entry is updated.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html#close--">close</a></span>()</code> |
| <div class="block">Called when the region containing this callback is closed or destroyed, when the cache is |
| closed, or when a callback is removed from a region using an <code>AttributesMutator</code>.</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.cache.Declarable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.geode.cache.<a href="../../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache">Declarable</a></h3> |
| <code><a href="../../../../../org/apache/geode/cache/Declarable.html#init-java.util.Properties-">init</a>, <a href="../../../../../org/apache/geode/cache/Declarable.html#initialize-org.apache.geode.cache.Cache-java.util.Properties-">initialize</a></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="CacheWriterAdapter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CacheWriterAdapter</h4> |
| <pre>public CacheWriterAdapter()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="beforeCreate-org.apache.geode.cache.EntryEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeCreate</h4> |
| <pre>public void beforeCreate(<a href="../../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event) |
| throws <a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeCreate-org.apache.geode.cache.EntryEvent-">CacheWriter</a></code></span></div> |
| <div class="block">Called before an entry is created. Entry creation is initiated by a <code>create</code>, a |
| <code>put</code>, or a <code>get</code>. The <code>CacheWriter</code> can determine whether |
| this value comes from a <code>get</code> or not by evaluating the |
| <a href="../../../../../org/apache/geode/cache/CacheEvent.html#getOperation--"><code>Operation</code></a>'s <a href="../../../../../org/apache/geode/cache/Operation.html#isLoad--"><code>Operation.isLoad()</code></a> method. The entry |
| being created may already exist in the local cache where this <code>CacheWriter</code> is |
| installed, but it does not yet exist in the cache where the operation was initiated.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeCreate-org.apache.geode.cache.EntryEvent-">beforeCreate</a></code> in interface <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - an EntryEvent that provides information about the operation in progress</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - if thrown will abort the operation in progress, and the exception |
| will be propagated back to caller that initiated the operation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beforeDestroy-org.apache.geode.cache.EntryEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeDestroy</h4> |
| <pre>public void beforeDestroy(<a href="../../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event) |
| throws <a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeDestroy-org.apache.geode.cache.EntryEvent-">CacheWriter</a></code></span></div> |
| <div class="block">Called before an entry is destroyed. The entry being destroyed may or may not exist in the |
| local cache where the CacheWriter is installed. This method is <em>not</em> called as a result |
| of expiration or <a href="../../../../../org/apache/geode/cache/Region.html#localDestroy-java.lang.Object-"><code>Region.localDestroy(Object)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeDestroy-org.apache.geode.cache.EntryEvent-">beforeDestroy</a></code> in interface <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - an EntryEvent that provides information about the operation in progress</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - if thrown will abort the operation in progress, and the exception |
| will be propagated back to caller that initiated the operation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/Region.html#destroy-java.lang.Object-"><code>Region.destroy(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beforeRegionDestroy-org.apache.geode.cache.RegionEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeRegionDestroy</h4> |
| <pre>public void beforeRegionDestroy(<a href="../../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event) |
| throws <a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeRegionDestroy-org.apache.geode.cache.RegionEvent-">CacheWriter</a></code></span></div> |
| <div class="block">Called before a region is destroyed. The <code>CacheWriter</code> will not additionally be |
| called for each entry that is destroyed in the region as a result of a region destroy. If the |
| region's subregions have <code>CacheWriter</code>s installed, then they will be called for the |
| cascading subregion destroys. This method is <em>not</em> called as a result of |
| <a href="../../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a>, <a href="../../../../../org/apache/geode/cache/Cache.html#close-boolean-"><code>Cache.close(boolean)</code></a>, or <a href="../../../../../org/apache/geode/cache/Region.html#localDestroyRegion--"><code>Region.localDestroyRegion()</code></a>. However, the |
| <a href="../../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a> method is invoked regardless of whether a region is destroyed locally. A |
| non-local region destroy results in an invocation of this method is followed by |
| an invocation of <a href="../../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a>. |
| <p> |
| WARNING: This method should not destroy or create any regions itself or a deadlock will occur.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeRegionDestroy-org.apache.geode.cache.RegionEvent-">beforeRegionDestroy</a></code> in interface <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - a RegionEvent that provides information about the operation</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - if thrown, will abort the operation in progress, and the exception |
| will be propagated back to the caller that initiated the operation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/Region.html#destroyRegion--"><code>Region.destroyRegion()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beforeRegionClear-org.apache.geode.cache.RegionEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeRegionClear</h4> |
| <pre>public void beforeRegionClear(<a href="../../../../../org/apache/geode/cache/RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event) |
| throws <a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeRegionClear-org.apache.geode.cache.RegionEvent-">CacheWriter</a></code></span></div> |
| <div class="block">Called before a region is cleared. The <code>CacheWriter</code> will not additionally be called |
| for each entry that is cleared in the region as a result of a region clear. |
| |
| <p> |
| WARNING: This method should not clear/destroy any regions</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeRegionClear-org.apache.geode.cache.RegionEvent-">beforeRegionClear</a></code> in interface <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - a RegionEvent that provides information about the operation</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - if thrown, will abort the operation in progress, and the exception |
| will be propagated back to the caller that initiated the operation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/Region.html#clear--"><code>Region.clear()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="beforeUpdate-org.apache.geode.cache.EntryEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeUpdate</h4> |
| <pre>public void beforeUpdate(<a href="../../../../../org/apache/geode/cache/EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>> event) |
| throws <a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeUpdate-org.apache.geode.cache.EntryEvent-">CacheWriter</a></code></span></div> |
| <div class="block">Called before an entry is updated. The entry update is initiated by a <code>put</code> or a |
| <code>get</code> that causes the loader to update an existing entry. The entry previously |
| existed in the cache where the operation was initiated, although the old value may have been |
| null. The entry being updated may or may not exist in the local cache where the CacheWriter is |
| installed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriter.html#beforeUpdate-org.apache.geode.cache.EntryEvent-">beforeUpdate</a></code> in interface <code><a href="../../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">K</a>,<a href="../../../../../org/apache/geode/cache/util/CacheWriterAdapter.html" title="type parameter in CacheWriterAdapter">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - an EntryEvent that provides information about the operation in progress</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code> - if thrown will abort the operation in progress, and the exception |
| will be propagated back to caller that initiated the operation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/Region.html#put-K-V-"><code>Region.put(Object, Object)</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Region.html#get-java.lang.Object-"><code>Region.get(Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/geode/cache/CacheCallback.html#close--">CacheCallback</a></code></span></div> |
| <div class="block">Called when the region containing this callback is closed or destroyed, when the cache is |
| closed, or when a callback is removed from a region using an <code>AttributesMutator</code>. |
| |
| <p> |
| Implementations should cleanup any external resources such as database connections. Any runtime |
| exceptions this method throws will be logged. |
| |
| <p> |
| It is possible for this method to be called multiple times on a single callback instance, so |
| implementations must be tolerant of this.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/CacheCallback.html#close--">close</a></code> in interface <code><a href="../../../../../org/apache/geode/cache/CacheCallback.html" title="interface in org.apache.geode.cache">CacheCallback</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/RegionService.html#close--"><code>RegionService.close()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Region.html#close--"><code>Region.close()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Region.html#localDestroyRegion--"><code>Region.localDestroyRegion()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/Region.html#destroyRegion--"><code>Region.destroyRegion()</code></a>, |
| <a href="../../../../../org/apache/geode/cache/AttributesMutator.html" title="interface in org.apache.geode.cache"><code>AttributesMutator</code></a></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/util/CacheListenerAdapter.html" title="class in org.apache.geode.cache.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/util/CqListenerAdapter.html" title="class in org.apache.geode.cache.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/util/CacheWriterAdapter.html" target="_top">Frames</a></li> |
| <li><a href="CacheWriterAdapter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |