| <!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_272) on Thu Nov 12 16:27:22 PST 2020 --> |
| <title>AttributesMutator (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <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="AttributesMutator (Apache Geode 1.13.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6}; |
| 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/AttributesFactory.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/Cache.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/AttributesMutator.html" target="_top">Frames</a></li> |
| <li><a href="AttributesMutator.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 AttributesMutator" class="title">Interface AttributesMutator<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">AttributesMutator<K,V></span></pre> |
| <div class="block">Supports modification of certain region attributes after the region has been created. It is |
| recommended that the attributes be completely initialized using an <a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</code></a> |
| before creating the region instead of using an <code>AttributesMutator</code> after region |
| creation. This will avoid a potential performance penalty due to the additional network traffic. |
| <p> |
| The setter methods all return the previous value of the attribute.</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.html#getAttributesMutator--"><code>Region.getAttributesMutator()</code></a>, |
| <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a>, |
| <a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</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></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/AttributesMutator.html#addAsyncEventQueueId-java.lang.String-">addAsyncEventQueueId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> asyncEventQueueId)</code> |
| <div class="block">Adds AsyncEventQueueId to the list of AsyncEventQueueId of the 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/AttributesMutator.html#addCacheListener-org.apache.geode.cache.CacheListener-">addCacheListener</a></span>(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> aListener)</code> |
| <div class="block">Adds a cache listener to the end of the list of cache listeners on this 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/AttributesMutator.html#addGatewaySenderId-java.lang.String-">addGatewaySenderId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> gatewaySenderId)</code> |
| <div class="block">Adds GatewaySenderId to the list of GatewaySenderIds of the region.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#getCloningEnabled--">getCloningEnabled</a></span>()</code> |
| <div class="block">Returns whether or not cloning is enabled on region</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/EvictionAttributesMutator.html" title="interface in org.apache.geode.cache">EvictionAttributesMutator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#getEvictionAttributesMutator--">getEvictionAttributesMutator</a></span>()</code> |
| <div class="block">Allows changing the eviction controller attributes for the region.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#getRegion--">getRegion</a></span>()</code> |
| <div class="block">Returns the Region whose attributes this mutator affects.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#initCacheListeners-org.apache.geode.cache.CacheListener:A-">initCacheListeners</a></span>(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>>[] newListeners)</code> |
| <div class="block">Removes all cache listeners, calling <a href="../../../../org/apache/geode/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> on each of them, and then adds |
| each listener in the specified array.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#removeAsyncEventQueueId-java.lang.String-">removeAsyncEventQueueId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> asyncEventQueueId)</code> |
| <div class="block">Removes AsyncEventQueueId from the list of AsyncEventQueuesId of the region.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#removeCacheListener-org.apache.geode.cache.CacheListener-">removeCacheListener</a></span>(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> aListener)</code> |
| <div class="block">Removes a cache listener from the list of cache listeners on this region.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#removeGatewaySenderId-java.lang.String-">removeGatewaySenderId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> gatewaySenderId)</code> |
| <div class="block">Removes GatewaySenderId from the list of GatewaySenderIds of the region.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setCacheLoader-org.apache.geode.cache.CacheLoader-">setCacheLoader</a></span>(<a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> cacheLoader)</code> |
| <div class="block">Changes the cache loader for the region.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setCacheWriter-org.apache.geode.cache.CacheWriter-">setCacheWriter</a></span>(<a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> cacheWriter)</code> |
| <div class="block">Changes the cache writer for the region.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setCloningEnabled-boolean-">setCloningEnabled</a></span>(boolean cloningEnable)</code> |
| <div class="block">Sets cloning on region Note: off-heap regions always behave as if cloning is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setCustomEntryIdleTimeout-org.apache.geode.cache.CustomExpiry-">setCustomEntryIdleTimeout</a></span>(<a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> custom)</code> |
| <div class="block">Changes the CustomExpiry for idleTimeout for values in the region</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setCustomEntryTimeToLive-org.apache.geode.cache.CustomExpiry-">setCustomEntryTimeToLive</a></span>(<a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> custom)</code> |
| <div class="block">Changes the custom timeToLive for values in this region</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setEntryIdleTimeout-org.apache.geode.cache.ExpirationAttributes-">setEntryIdleTimeout</a></span>(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> idleTimeout)</code> |
| <div class="block">Changes the idleTimeout expiration attributes for values in the region.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setEntryTimeToLive-org.apache.geode.cache.ExpirationAttributes-">setEntryTimeToLive</a></span>(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> timeToLive)</code> |
| <div class="block">Changes the timeToLive expiration attributes for values in this region.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setRegionIdleTimeout-org.apache.geode.cache.ExpirationAttributes-">setRegionIdleTimeout</a></span>(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> idleTimeout)</code> |
| <div class="block">Changes the idleTimeout expiration attributes for the region as a whole.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/AttributesMutator.html#setRegionTimeToLive-org.apache.geode.cache.ExpirationAttributes-">setRegionTimeToLive</a></span>(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> timeToLive)</code> |
| <div class="block">Changes the timeToLive expiration attributes for the region as a whole</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="getRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegion</h4> |
| <pre><a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> getRegion()</pre> |
| <div class="block">Returns the Region whose attributes this mutator affects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Region this mutator affects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRegionTimeToLive-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRegionTimeToLive</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> setRegionTimeToLive(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> timeToLive)</pre> |
| <div class="block">Changes the timeToLive expiration attributes for the region as a whole</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeToLive</code> - the expiration attributes for the region timeToLive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous value of region timeToLive</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if timeToLive is null or if the ExpirationAction is |
| LOCAL_INVALIDATE and the region is <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replicated</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if statistics are disabled for this region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRegionIdleTimeout-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRegionIdleTimeout</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> setRegionIdleTimeout(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> idleTimeout)</pre> |
| <div class="block">Changes the idleTimeout expiration attributes for the region as a whole. Resets the |
| <a href="../../../../org/apache/geode/cache/CacheStatistics.html#getLastAccessedTime--"><code>CacheStatistics.getLastAccessedTime()</code></a> for the region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idleTimeout</code> - the ExpirationAttributes for this region idleTimeout</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous value of region idleTimeout</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if idleTimeout is null or if the ExpirationAction is |
| LOCAL_INVALIDATE and the region is <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replicated</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if statistics are disabled for this region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEntryTimeToLive-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntryTimeToLive</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> setEntryTimeToLive(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> timeToLive)</pre> |
| <div class="block">Changes the timeToLive expiration attributes for values in this region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeToLive</code> - the timeToLive expiration attributes for entries</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous value of entry timeToLive</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if timeToLive is null or if the ExpirationAction is |
| LOCAL_DESTROY and the region is <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replicated</code></a> or if the |
| ExpirationAction is LOCAL_INVALIDATE and the region is |
| <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replicated</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if statistics are disabled for this region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCustomEntryTimeToLive-org.apache.geode.cache.CustomExpiry-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCustomEntryTimeToLive</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> setCustomEntryTimeToLive(<a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> custom)</pre> |
| <div class="block">Changes the custom timeToLive for values in this region</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>custom</code> - the new CustomExpiry</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the old CustomExpiry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEntryIdleTimeout-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntryIdleTimeout</h4> |
| <pre><a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> setEntryIdleTimeout(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> idleTimeout)</pre> |
| <div class="block">Changes the idleTimeout expiration attributes for values in the region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idleTimeout</code> - the idleTimeout expiration attributes for entries</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous value of entry idleTimeout</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if idleTimeout is null or if the ExpirationAction is |
| LOCAL_DESTROY and the region is <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replicated</code></a> or if the |
| the ExpirationAction is LOCAL_INVALIDATE and the region is |
| <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replicated</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if statistics are disabled for this region.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setStatisticsEnabled-boolean-"><code>AttributesFactory.setStatisticsEnabled(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCustomEntryIdleTimeout-org.apache.geode.cache.CustomExpiry-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCustomEntryIdleTimeout</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> setCustomEntryIdleTimeout(<a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache">CustomExpiry</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> custom)</pre> |
| <div class="block">Changes the CustomExpiry for idleTimeout for values in the region</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>custom</code> - the new CustomExpiry</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the old CustomExpiry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addCacheListener-org.apache.geode.cache.CacheListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCacheListener</h4> |
| <pre>void addCacheListener(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> aListener)</pre> |
| <div class="block">Adds a cache listener to the end of the list of cache listeners on this region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aListener</code> - the user defined cache listener to add to the region.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>aListener</code> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeCacheListener-org.apache.geode.cache.CacheListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeCacheListener</h4> |
| <pre>void removeCacheListener(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> aListener)</pre> |
| <div class="block">Removes a cache listener from the list of cache listeners on this region. Does nothing if the |
| specified listener has not been added. If the specified listener has been added then |
| <a href="../../../../org/apache/geode/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> will be called on it; otherwise does nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aListener</code> - the cache listener to remove from the region.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>aListener</code> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initCacheListeners-org.apache.geode.cache.CacheListener:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initCacheListeners</h4> |
| <pre>void initCacheListeners(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>>[] newListeners)</pre> |
| <div class="block">Removes all cache listeners, calling <a href="../../../../org/apache/geode/cache/CacheCallback.html#close--"><code>CacheCallback.close()</code></a> on each of them, and then adds |
| each listener in the specified array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newListeners</code> - a possibly null or empty array of listeners to add to this region.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the <code>newListeners</code> array has a null element</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheWriter-org.apache.geode.cache.CacheWriter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheWriter</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> setCacheWriter(<a href="../../../../org/apache/geode/cache/CacheWriter.html" title="interface in org.apache.geode.cache">CacheWriter</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> cacheWriter)</pre> |
| <div class="block">Changes the cache writer for the region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cacheWriter</code> - the cache writer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous CacheWriter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheLoader-org.apache.geode.cache.CacheLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheLoader</h4> |
| <pre><a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> setCacheLoader(<a href="../../../../org/apache/geode/cache/CacheLoader.html" title="interface in org.apache.geode.cache">CacheLoader</a><<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">K</a>,<a href="../../../../org/apache/geode/cache/AttributesMutator.html" title="type parameter in AttributesMutator">V</a>> cacheLoader)</pre> |
| <div class="block">Changes the cache loader for the region. |
| |
| Changing the cache loader for partitioned regions is not recommended due to the fact that it |
| can result in an inconsistent cache loader configuration. This feature may be removed in future |
| releases.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cacheLoader</code> - the cache loader</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the previous CacheLoader</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEvictionAttributesMutator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionAttributesMutator</h4> |
| <pre><a href="../../../../org/apache/geode/cache/EvictionAttributesMutator.html" title="interface in org.apache.geode.cache">EvictionAttributesMutator</a> getEvictionAttributesMutator()</pre> |
| <div class="block">Allows changing the eviction controller attributes for the region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../org/apache/geode/cache/EvictionAttributesMutator.html" title="interface in org.apache.geode.cache"><code>EvictionAttributesMutator</code></a> used to change the EvictionAttributes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCloningEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCloningEnabled</h4> |
| <pre>void setCloningEnabled(boolean cloningEnable)</pre> |
| <div class="block">Sets cloning on region Note: off-heap regions always behave as if cloning is enabled.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCloningEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCloningEnabled</h4> |
| <pre>boolean getCloningEnabled()</pre> |
| <div class="block">Returns whether or not cloning is enabled on region</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if cloning is enabled (default); false cloning is not enabled.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addGatewaySenderId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addGatewaySenderId</h4> |
| <pre>void addGatewaySenderId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> gatewaySenderId)</pre> |
| <div class="block">Adds GatewaySenderId to the list of GatewaySenderIds of the region. If the GatewaySenderId is |
| not present on this VM then it will try to send it to other VM's</div> |
| </li> |
| </ul> |
| <a name="removeGatewaySenderId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeGatewaySenderId</h4> |
| <pre>void removeGatewaySenderId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> gatewaySenderId)</pre> |
| <div class="block">Removes GatewaySenderId from the list of GatewaySenderIds of the region.</div> |
| </li> |
| </ul> |
| <a name="addAsyncEventQueueId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAsyncEventQueueId</h4> |
| <pre>void addAsyncEventQueueId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> asyncEventQueueId)</pre> |
| <div class="block">Adds AsyncEventQueueId to the list of AsyncEventQueueId of the region.</div> |
| </li> |
| </ul> |
| <a name="removeAsyncEventQueueId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeAsyncEventQueueId</h4> |
| <pre>void removeAsyncEventQueueId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> asyncEventQueueId)</pre> |
| <div class="block">Removes AsyncEventQueueId from the list of AsyncEventQueuesId of the region.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/Cache.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/AttributesMutator.html" target="_top">Frames</a></li> |
| <li><a href="AttributesMutator.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> |