| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CacheEvent (geode-core 2.0.0 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.geode.cache, interface: CacheEvent"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.geode.cache</a></div> |
| <h1 title="Interface CacheEvent" class="title">Interface CacheEvent<K,<wbr>V></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="EntryEvent.html" title="interface in org.apache.geode.cache">EntryEvent</a><K,<wbr>V></code>, <code><a href="RegionEvent.html" title="interface in org.apache.geode.cache">RegionEvent</a><K,<wbr>V></code>, <code><a href="RoleEvent.html" title="interface in org.apache.geode.cache">RoleEvent</a><K,<wbr>V></code>, <code><a href="util/TimestampedEntryEvent.html" title="interface in org.apache.geode.cache.util">TimestampedEntryEvent</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">CacheEvent<K,<wbr>V></span></div> |
| <div class="block">A region- or entry-related event affecting the cache. |
| <P> |
| Prior to release <code>6.0</code> the <code>NOT_AVAILABLE</code> constant was used to indicate an |
| object value was not available. However in <code>6.0</code> generic typing was added to |
| <a href="Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> and since this constant's type will not be an instance of the generic type |
| <code>V</code> returning it would cause a ClassCastException. So in <code>6.0</code> and later |
| <code>null</code> is now used in place of <code>NOT_AVAILABLE</code>.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>GemFire 2.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="CacheListener.html" title="interface in org.apache.geode.cache"><code>CacheListener</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCallbackArgument()" class="member-name-link">getCallbackArgument</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the callbackArgument passed to the method that generated this event.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDistributedMember()" class="member-name-link">getDistributedMember</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the <a href="../distributed/DistributedMember.html" title="interface in org.apache.geode.distributed"><code>DistributedMember</code></a> that this event originated in.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Operation.html" title="class in org.apache.geode.cache">Operation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOperation()" class="member-name-link">getOperation</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a description of the operation that triggered this event.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="CacheEvent.html" title="type parameter in CacheEvent">K</a>,<wbr><a href="CacheEvent.html" title="type parameter in CacheEvent">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRegion()" class="member-name-link">getRegion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the region to which this cached object belongs or the region that raised this event for |
| <code>RegionEvent</code>s.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isCallbackArgumentAvailable()" class="member-name-link">isCallbackArgumentAvailable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns <code>true</code> if the callback argument is "available".</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isOriginRemote()" class="member-name-link">isOriginRemote</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Answer true if this event originated in a cache other than this one.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getRegion()"> |
| <h3>getRegion</h3> |
| <div class="member-signature"><span class="return-type"><a href="Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="CacheEvent.html" title="type parameter in CacheEvent">K</a>,<wbr><a href="CacheEvent.html" title="type parameter in CacheEvent">V</a>></span> <span class="element-name">getRegion</span>()</div> |
| <div class="block">Returns the region to which this cached object belongs or the region that raised this event for |
| <code>RegionEvent</code>s.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the region associated with this object or the region that raised this event.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperation()"> |
| <h3>getOperation</h3> |
| <div class="member-signature"><span class="return-type"><a href="Operation.html" title="class in org.apache.geode.cache">Operation</a></span> <span class="element-name">getOperation</span>()</div> |
| <div class="block">Return a description of the operation that triggered this event.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the operation that triggered this event.</dd> |
| <dt>Since:</dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCallbackArgument()"> |
| <h3>getCallbackArgument</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getCallbackArgument</span>()</div> |
| <div class="block">Returns the callbackArgument passed to the method that generated this event. Provided primarily |
| in case this object or region has already been destroyed. See the <a href="Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> interface |
| methods that take a callbackArgument parameter.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the callbackArgument associated with this event. <code>null</code> is returned if the |
| callback argument is not propagated to the event. This happens for events given to |
| <a href="TransactionListener.html" title="interface in org.apache.geode.cache"><code>TransactionListener</code></a> and to <a href="CacheListener.html" title="interface in org.apache.geode.cache"><code>CacheListener</code></a> on the remote side of a |
| transaction commit.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCallbackArgumentAvailable()"> |
| <h3>isCallbackArgumentAvailable</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isCallbackArgumentAvailable</span>()</div> |
| <div class="block">Returns <code>true</code> if the callback argument is "available". Not available means that the |
| callback argument may have existed but it could not be obtained. Note that |
| <a href="#getCallbackArgument()"><code>getCallbackArgument()</code></a> will return <code>null</code> when this method returns |
| <code>false</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether the callback argument is "available"</dd> |
| <dt>Since:</dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOriginRemote()"> |
| <h3>isOriginRemote</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isOriginRemote</span>()</div> |
| <div class="block">Answer true if this event originated in a cache other than this one. Answer false if this event |
| originated in this cache.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this event originated remotely</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDistributedMember()"> |
| <h3>getDistributedMember</h3> |
| <div class="member-signature"><span class="return-type"><a href="../distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a></span> <span class="element-name">getDistributedMember</span>()</div> |
| <div class="block">Returns the <a href="../distributed/DistributedMember.html" title="interface in org.apache.geode.distributed"><code>DistributedMember</code></a> that this event originated in.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the member that performed the operation that originated this event.</dd> |
| <dt>Since:</dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
