| <!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>RegionFactory (Apache Geode 1.15.0)</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="RegionFactory (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":42,"i18":42,"i19":10,"i20":10,"i21":42,"i22":42,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":42,"i35":10,"i36":10,"i37":10,"i38":10,"i39":42,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/RegionMembershipListener.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/RegionFactory.html" target="_top">Frames</a></li> |
| <li><a href="RegionFactory.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</div> |
| <h2 title="Class RegionFactory" class="title">Class RegionFactory<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.RegionFactory<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RegionFactory<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></pre> |
| <div class="block"><code>RegionFactory</code> is used to create <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>regions</code></a> in a <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>cache</code></a>. |
| Instances of this interface can be created: |
| <ul> |
| <li>using a <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>shortcut</code></a> by calling |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionShortcut-"><code>Cache.createRegionFactory(RegionShortcut)</code></a> which will initialize the factory with the |
| shortcut's region attributes |
| <li>using a named region attribute by calling <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-java.lang.String-"><code>Cache.createRegionFactory(String)</code></a> which |
| will initialize the factory the named region attributes |
| <li>using a region attribute instance by calling |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>Cache.createRegionFactory(RegionAttributes)</code></a> which will initialize the factory with the |
| given region attributes |
| <li>by calling <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory--"><code>Cache.createRegionFactory()</code></a> which will initialize the factory with |
| defaults |
| </ul> |
| Once the factory has been created it can be customized with its setter methods. |
| <p> |
| The final step is to produce a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a> by calling <a href="../../../../org/apache/geode/cache/RegionFactory.html#create-java.lang.String-"><code>create(String)</code></a>. |
| <p> |
| Example: Create a replicate region with a CacheListener |
| |
| <PRE> |
| Cache c = new CacheFactory().create(); |
| // Create replicate region. |
| // Add a cache listener before creating region |
| Region r = c.createRegionFactory(REPLICATE).addCacheListener(myListener).create("replicate"); |
| </PRE> |
| <p> |
| Example: Create a partition region that has redundancy |
| |
| <PRE> |
| Cache c = new CacheFactory().create(); |
| // Create replicate region. |
| // Add a cache listener before creating region |
| Region r = c.createRegionFactory(PARTITION_REDUNDANT).create("partition"); |
| </PRE></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory--">RegionFactory</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory--"><code>Cache.createRegionFactory()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-org.apache.geode.internal.cache.InternalCache-">RegionFactory</a></span>(org.apache.geode.internal.cache.InternalCache cache)</code> |
| <div class="block">For internal use only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-org.apache.geode.internal.cache.InternalCache-org.apache.geode.cache.RegionAttributes-">RegionFactory</a></span>(org.apache.geode.internal.cache.InternalCache cache, |
| <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a> ra)</code> |
| <div class="block">For internal use only.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-org.apache.geode.internal.cache.InternalCache-org.apache.geode.cache.RegionShortcut-">RegionFactory</a></span>(org.apache.geode.internal.cache.InternalCache cache, |
| <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache">RegionShortcut</a> pra)</code> |
| <div class="block">For internal use only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-org.apache.geode.internal.cache.InternalCache-java.lang.String-">RegionFactory</a></span>(org.apache.geode.internal.cache.InternalCache cache, |
| <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> regionAttributesId)</code> |
| <div class="block">For internal use only.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-java.util.Properties-">RegionFactory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> distributedSystemProperties)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> and |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory--"><code>Cache.createRegionFactory()</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-java.util.Properties-org.apache.geode.cache.RegionAttributes-">RegionFactory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> distributedSystemProperties, |
| <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> regionAttributes)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> and |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>Cache.createRegionFactory(RegionAttributes)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-java.util.Properties-java.lang.String-">RegionFactory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> distributedSystemProperties, |
| <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> regionAttributesId)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> and |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-java.lang.String-"><code>Cache.createRegionFactory(String)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-org.apache.geode.cache.RegionAttributes-">RegionFactory</a></span>(<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> regionAttributes)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>Cache.createRegionFactory(RegionAttributes)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-org.apache.geode.cache.RegionFactory-">RegionFactory</a></span>(<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> regionFactory)</code> |
| <div class="block">Constructs a RegionFactory that is a copy of an existing RegionFactory</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#RegionFactory-java.lang.String-">RegionFactory</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> regionAttributesId)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-java.lang.String-"><code>Cache.createRegionFactory(String)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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 a asyncEventQueueId to the RegionAttributes</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> aListener)</code> |
| <div class="block">Adds a cache listener to the end of the list of cache listeners on this factory.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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 a gatewaySenderId to the RegionAttributes</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#create-java.lang.String-">create</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> name)</code> |
| <div class="block">Creates a region with the given name in this factory's <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> using the configuration |
| contained in this factory.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#createSubregion-org.apache.geode.cache.Region-java.lang.String-">createSubregion</a></span>(<a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><?,?> parent, |
| <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> name)</code> |
| <div class="block">Creates a sub-region in the <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> using the configuration contained in this |
| RegionFactory.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.geode.internal.cache.InternalCache</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#getCache--">getCache</a></span>()</code> |
| <div class="block">Returns the cache used by this factory.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#getRegionAttributes--">getRegionAttributes</a></span>()</code> |
| <div class="block">Returns the attributes used by this factory to create a region.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>>[] newListeners)</code> |
| <div class="block">Removes all cache listeners and then adds each listener in the specified array.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> cacheLoader)</code> |
| <div class="block">Sets the cache loader for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> cacheWriter)</code> |
| <div class="block">Sets the cache writer for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setCompressor-org.apache.geode.compression.Compressor-">setCompressor</a></span>(<a href="../../../../org/apache/geode/compression/Compressor.html" title="interface in org.apache.geode.compression">Compressor</a> compressor)</code> |
| <div class="block">Set the compressor to be used by this region for compressing region entry values.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setConcurrencyChecksEnabled-boolean-">setConcurrencyChecksEnabled</a></span>(boolean enabled)</code> |
| <div class="block">Enables a versioning system that detects concurrent modifications and ensures that region |
| contents are consistent across the distributed system.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setConcurrencyLevel-int-">setConcurrencyLevel</a></span>(int concurrencyLevel)</code> |
| <div class="block">Sets the concurrency level tof the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> custom)</code> |
| <div class="block">Sets the custom idleTimeout for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> custom)</code> |
| <div class="block">Sets the custom timeToLive expiration method for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setDataPolicy-org.apache.geode.cache.DataPolicy-">setDataPolicy</a></span>(<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> dataPolicy)</code> |
| <div class="block">Sets the data policy for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskDirs-java.io.File:A-">setDiskDirs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] diskDirs)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskDirs-java.io.File:A-"><code>DiskStoreFactory.setDiskDirs(java.io.File[])</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-">setDiskDirsAndSizes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] diskDirs, |
| int[] diskSizes)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-"><code>DiskStoreFactory.setDiskDirsAndSizes(java.io.File[], int[])</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskStoreName-java.lang.String-">setDiskStoreName</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> name)</code> |
| <div class="block">Sets the DiskStore name attribute.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskSynchronous-boolean-">setDiskSynchronous</a></span>(boolean isSynchronous)</code> |
| <div class="block">Sets whether or not the writing to the disk is synchronous.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskWriteAttributes-org.apache.geode.cache.DiskWriteAttributes-">setDiskWriteAttributes</a></span>(<a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html" title="interface in org.apache.geode.cache">DiskWriteAttributes</a> attrs)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setEarlyAck-boolean-">setEarlyAck</a></span>(boolean earlyAck)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of 6.5 this setting no longer has any effect.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setEnableAsyncConflation-boolean-">setEnableAsyncConflation</a></span>(boolean value)</code> |
| <div class="block">Sets whether or not conflation is enabled for sending messages to async peers.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setEnableSubscriptionConflation-boolean-">setEnableSubscriptionConflation</a></span>(boolean value)</code> |
| <div class="block">Sets whether or not conflation is enabled for sending messages from a cache server to its |
| clients.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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">Sets the idleTimeout expiration attributes for region entries for the next |
| <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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">Sets the timeToLive expiration attributes for region entries for the next |
| <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setEvictionAttributes-org.apache.geode.cache.EvictionAttributes-">setEvictionAttributes</a></span>(<a href="../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache">EvictionAttributes</a> evictionAttributes)</code> |
| <div class="block">Sets the eviction attributes that controls growth of the Region to be created.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setIgnoreJTA-boolean-">setIgnoreJTA</a></span>(boolean flag)</code> |
| <div class="block">Sets whether operations on this region should be controlled by JTA transactions or not</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setIndexMaintenanceSynchronous-boolean-">setIndexMaintenanceSynchronous</a></span>(boolean synchronous)</code> |
| <div class="block">Sets how indexes on this region are kept current.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setInitialCapacity-int-">setInitialCapacity</a></span>(int initialCapacity)</code> |
| <div class="block">Sets the entry initial capacity for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setKeyConstraint-java.lang.Class-">setKeyConstraint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>> keyConstraint)</code> |
| <div class="block">Sets the key constraint for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setLoadFactor-float-">setLoadFactor</a></span>(float loadFactor)</code> |
| <div class="block">Sets the entry load factor for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setLockGrantor-boolean-">setLockGrantor</a></span>(boolean isLockGrantor)</code> |
| <div class="block">Sets whether this region should become lock grantor.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setMembershipAttributes-org.apache.geode.cache.MembershipAttributes-">setMembershipAttributes</a></span>(<a href="../../../../org/apache/geode/cache/MembershipAttributes.html" title="class in org.apache.geode.cache">MembershipAttributes</a> ra)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">this API is scheduled to be removed</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setMulticastEnabled-boolean-">setMulticastEnabled</a></span>(boolean value)</code> |
| <div class="block">Sets whether distributed operations on this region should attempt to use multicast.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setOffHeap-boolean-">setOffHeap</a></span>(boolean offHeap)</code> |
| <div class="block">Enables this region's usage of off-heap memory if true.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setPartitionAttributes-org.apache.geode.cache.PartitionAttributes-">setPartitionAttributes</a></span>(<a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a> partition)</code> |
| <div class="block">Sets the <code>PartitionAttributes</code> that describe how the region is partitioned among members |
| of the distributed system.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setPoolName-java.lang.String-">setPoolName</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> poolName)</code> |
| <div class="block">Sets the pool name attribute.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setPublisher-boolean-">setPublisher</a></span>(boolean v)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">as of 6.5</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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">Sets the idleTimeout expiration attributes for the region itself for the next |
| <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.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">Sets the timeToLive expiration attributes for the region itself for the next |
| <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setScope-org.apache.geode.cache.Scope-">setScope</a></span>(<a href="../../../../org/apache/geode/cache/Scope.html" title="class in org.apache.geode.cache">Scope</a> scopeType)</code> |
| <div class="block">Sets the scope for the next <code>RegionAttributes</code> created.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setStatisticsEnabled-boolean-">setStatisticsEnabled</a></span>(boolean statisticsEnabled)</code> |
| <div class="block">Sets whether statistics are enabled for this region and its entries.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setSubscriptionAttributes-org.apache.geode.cache.SubscriptionAttributes-">setSubscriptionAttributes</a></span>(<a href="../../../../org/apache/geode/cache/SubscriptionAttributes.html" title="class in org.apache.geode.cache">SubscriptionAttributes</a> sa)</code> |
| <div class="block">Sets the kind of interest this region has in events occuring in other caches that define the |
| region by the same name.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/RegionFactory.html#setValueConstraint-java.lang.Class-">setValueConstraint</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> valueConstraint)</code> |
| <div class="block">Sets the value constraint for the next <code>RegionAttributes</code> created.</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> |
| </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="RegionFactory-org.apache.geode.internal.cache.InternalCache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre>protected RegionFactory(org.apache.geode.internal.cache.InternalCache cache)</pre> |
| <div class="block">For internal use only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the cache</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-org.apache.geode.internal.cache.InternalCache-org.apache.geode.cache.RegionShortcut-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre>protected RegionFactory(org.apache.geode.internal.cache.InternalCache cache, |
| <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache">RegionShortcut</a> pra)</pre> |
| <div class="block">For internal use only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the cache</dd> |
| <dd><code>pra</code> - the <a href="../../../../org/apache/geode/cache/RegionShortcut.html" title="enum in org.apache.geode.cache"><code>RegionShortcut</code></a> with which to initialize the Region</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-org.apache.geode.internal.cache.InternalCache-org.apache.geode.cache.RegionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre>protected RegionFactory(org.apache.geode.internal.cache.InternalCache cache, |
| <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a> ra)</pre> |
| <div class="block">For internal use only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the cache</dd> |
| <dd><code>ra</code> - the <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> with which to initialize the Region</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-org.apache.geode.cache.RegionFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="../../../../org/apache/geode/annotations/VisibleForTesting.html" title="annotation in org.apache.geode.annotations">@VisibleForTesting</a> |
| protected RegionFactory(<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> regionFactory)</pre> |
| <div class="block">Constructs a RegionFactory that is a copy of an existing RegionFactory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionFactory</code> - the RegionFactory to copy</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.12.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-org.apache.geode.internal.cache.InternalCache-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre>protected RegionFactory(org.apache.geode.internal.cache.InternalCache cache, |
| <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> regionAttributesId)</pre> |
| <div class="block">For internal use only.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the cache</dd> |
| <dd><code>regionAttributesId</code> - the id of the <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> with which to initialize the |
| Region</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public RegionFactory() |
| throws <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory--"><code>Cache.createRegionFactory()</code></a> instead.</span></div> |
| <div class="block">Constructs a RegionFactory by creating a DistributedSystem and a Cache. If no DistributedSystem |
| exists it creates a DistributedSystem with default configuration, otherwise it uses the |
| existing DistributedSystem. The default Region configuration is used.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code> - if unable to connect the DistributedSystem or create a Cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-org.apache.geode.cache.RegionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public RegionFactory(<a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> regionAttributes) |
| throws <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>Cache.createRegionFactory(RegionAttributes)</code></a> instead.</span></div> |
| <div class="block">Constructs a RegionFactory by creating a DistributedSystem and a Cache. If no DistributedSystem |
| exists it creates a DistributedSystem with default configuration, otherwise it uses the |
| existing DistributedSystem. The Region configuration is initialized using the provided |
| RegionAttributes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionAttributes</code> - the <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> with which to initialize the Region</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code> - if unable to connect the DistributedSystem or create a Cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public RegionFactory(<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> regionAttributesId) |
| throws <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-java.lang.String-"><code>Cache.createRegionFactory(String)</code></a> instead.</span></div> |
| <div class="block">Constructs a RegionFactory by creating a DistributedSystem and a Cache. If no DistributedSystem |
| exists it creates a DistributedSystem with default configuration, otherwise it uses the |
| existing DistributedSystem. The Region configuration is initialized using the RegionAttributes |
| identified in the cache.xml file by the provided identifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionAttributesId</code> - that identifies a set of RegionAttributes in the cache-xml file.</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 there are no attributes associated with the id</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code> - if unable to connect the DistributedSystem or create a Cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/GemFireCache.html#getRegionAttributes-java.lang.String-"><code>GemFireCache.getRegionAttributes(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public RegionFactory(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> distributedSystemProperties) |
| throws <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> and |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory--"><code>Cache.createRegionFactory()</code></a> instead.</span></div> |
| <div class="block">Constructs a RegionFactory by creating a DistributedSystem and a Cache. If a DistributedSystem |
| already exists with the same properties it uses that DistributedSystem, otherwise a |
| DistributedSystem is created using the provided properties. The default Region configuration is |
| used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>distributedSystemProperties</code> - an instance of Properties containing |
| <code>DistributedSystem</code> configuration</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code> - if unable to connect the DistributedSystem or create a Cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-java.util.Properties-org.apache.geode.cache.RegionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public RegionFactory(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> distributedSystemProperties, |
| <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> regionAttributes) |
| throws <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> and |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-org.apache.geode.cache.RegionAttributes-"><code>Cache.createRegionFactory(RegionAttributes)</code></a> instead.</span></div> |
| <div class="block">Constructs a RegionFactory by creating a DistributedSystem and a Cache. If a DistributedSystem |
| already exists with the same properties it uses that DistributedSystem, otherwise a |
| DistributedSystem is created using the provided properties. The initial Region configuration is |
| set using the RegionAttributes provided.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>distributedSystemProperties</code> - properties used to either find or create a |
| DistributedSystem.</dd> |
| <dd><code>regionAttributes</code> - the initial Region configuration for this RegionFactory.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code> - if unable to connect the DistributedSystem or create a Cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RegionFactory-java.util.Properties-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RegionFactory</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public RegionFactory(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> distributedSystemProperties, |
| <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> regionAttributesId) |
| throws <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/CacheFactory.html#CacheFactory-java.util.Properties-"><code>CacheFactory(Properties)</code></a> and |
| <a href="../../../../org/apache/geode/cache/Cache.html#createRegionFactory-java.lang.String-"><code>Cache.createRegionFactory(String)</code></a> instead.</span></div> |
| <div class="block">Constructs a RegionFactory by creating a DistributedSystem and a Cache. If a DistributedSystem |
| already exists whose properties match those provied, it uses that DistributedSystem. The Region |
| configuration is initialized using the RegionAttributes identified in the cache.xml file by the |
| provided identifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>distributedSystemProperties</code> - properties used to either find or create a |
| DistributedSystem.</dd> |
| <dd><code>regionAttributesId</code> - the identifier for set of RegionAttributes in the cache.xml file used |
| as the initial Region configuration for this RegionFactory.</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 there are no attributes associated with the id</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache">CacheException</a></code> - if unable to connect the DistributedSystem or create a Cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCache</h4> |
| <pre>protected org.apache.geode.internal.cache.InternalCache getCache()</pre> |
| <div class="block">Returns the cache used by this factory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>he cache used by this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionAttributes</h4> |
| <pre>protected <a href="../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache">RegionAttributes</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> getRegionAttributes()</pre> |
| <div class="block">Returns the attributes used by this factory to create a region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the attributes used by this factory to create a region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheLoader-org.apache.geode.cache.CacheLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheLoader</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> cacheLoader)</pre> |
| <div class="block">Sets the cache loader for the next <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cacheLoader</code> - the cache loader or null if no loader</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setCacheLoader-org.apache.geode.cache.CacheLoader-"><code>AttributesFactory.setCacheLoader(org.apache.geode.cache.CacheLoader<K, V>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCacheWriter-org.apache.geode.cache.CacheWriter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheWriter</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> cacheWriter)</pre> |
| <div class="block">Sets the cache writer for the next <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cacheWriter</code> - the cache writer or null if no cache writer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setCacheWriter-org.apache.geode.cache.CacheWriter-"><code>AttributesFactory.setCacheWriter(org.apache.geode.cache.CacheWriter<K, V>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addCacheListener-org.apache.geode.cache.CacheListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCacheListener</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> addCacheListener(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> aListener)</pre> |
| <div class="block">Adds a cache listener to the end of the list of cache listeners on this factory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aListener</code> - the cache listener to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#addCacheListener-org.apache.geode.cache.CacheListener-"><code>AttributesFactory.addCacheListener(org.apache.geode.cache.CacheListener<K, V>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initCacheListeners-org.apache.geode.cache.CacheListener:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initCacheListeners</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> initCacheListeners(<a href="../../../../org/apache/geode/cache/CacheListener.html" title="interface in org.apache.geode.cache">CacheListener</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>>[] newListeners)</pre> |
| <div class="block">Removes all cache listeners and then adds each listener in the specified array. for the next |
| <code>RegionAttributes</code> created.</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 factory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#initCacheListeners-org.apache.geode.cache.CacheListener:A-"><code>AttributesFactory.initCacheListeners(org.apache.geode.cache.CacheListener<K, V>[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEvictionAttributes-org.apache.geode.cache.EvictionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEvictionAttributes</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setEvictionAttributes(<a href="../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache">EvictionAttributes</a> evictionAttributes)</pre> |
| <div class="block">Sets the eviction attributes that controls growth of the Region to be created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>evictionAttributes</code> - for the Region to create</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEntryIdleTimeout-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntryIdleTimeout</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setEntryIdleTimeout(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> idleTimeout)</pre> |
| <div class="block">Sets the idleTimeout expiration attributes for region entries for the next |
| <code>RegionAttributes</code> created. Note that the XML element that corresponds to this method |
| "entry-idle-time", does not include "out" in its name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>idleTimeout</code> - the idleTimeout ExpirationAttributes for entries in this region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setEntryIdleTimeout-org.apache.geode.cache.ExpirationAttributes-"><code>AttributesFactory.setEntryIdleTimeout(org.apache.geode.cache.ExpirationAttributes)</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>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> custom)</pre> |
| <div class="block">Sets the custom idleTimeout for the next <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>custom</code> - the custom method</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setCustomEntryIdleTimeout-org.apache.geode.cache.CustomExpiry-"><code>AttributesFactory.setCustomEntryIdleTimeout(CustomExpiry)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEntryTimeToLive-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntryTimeToLive</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setEntryTimeToLive(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> timeToLive)</pre> |
| <div class="block">Sets the timeToLive expiration attributes for region entries for the next |
| <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeToLive</code> - the timeToLive ExpirationAttributes for entries in this region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setEntryTimeToLive-org.apache.geode.cache.ExpirationAttributes-"><code>AttributesFactory.setEntryTimeToLive(org.apache.geode.cache.ExpirationAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCustomEntryTimeToLive-org.apache.geode.cache.CustomExpiry-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCustomEntryTimeToLive</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">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/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> custom)</pre> |
| <div class="block">Sets the custom timeToLive expiration method for the next <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>custom</code> - the custom method</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setCustomEntryTimeToLive-org.apache.geode.cache.CustomExpiry-"><code>AttributesFactory.setCustomEntryTimeToLive(CustomExpiry)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRegionIdleTimeout-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRegionIdleTimeout</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setRegionIdleTimeout(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> idleTimeout)</pre> |
| <div class="block">Sets the idleTimeout expiration attributes for the region itself for the next |
| <code>RegionAttributes</code> created. Note that the XML element that corresponds to this method |
| "region-idle-time", does not include "out" in its name.</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>a reference to this RegionFactory object</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</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setRegionIdleTimeout-org.apache.geode.cache.ExpirationAttributes-"><code>AttributesFactory.setRegionIdleTimeout(org.apache.geode.cache.ExpirationAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRegionTimeToLive-org.apache.geode.cache.ExpirationAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRegionTimeToLive</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setRegionTimeToLive(<a href="../../../../org/apache/geode/cache/ExpirationAttributes.html" title="class in org.apache.geode.cache">ExpirationAttributes</a> timeToLive)</pre> |
| <div class="block">Sets the timeToLive expiration attributes for the region itself for the next |
| <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeToLive</code> - the ExpirationAttributes for this region timeToLive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setRegionTimeToLive-org.apache.geode.cache.ExpirationAttributes-"><code>AttributesFactory.setRegionTimeToLive(org.apache.geode.cache.ExpirationAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setScope-org.apache.geode.cache.Scope-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScope</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setScope(<a href="../../../../org/apache/geode/cache/Scope.html" title="class in org.apache.geode.cache">Scope</a> scopeType)</pre> |
| <div class="block">Sets the scope for the next <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scopeType</code> - the type of Scope to use for the region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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 scopeType is null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setScope-org.apache.geode.cache.Scope-"><code>AttributesFactory.setScope(org.apache.geode.cache.Scope)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDataPolicy-org.apache.geode.cache.DataPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataPolicy</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setDataPolicy(<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> dataPolicy)</pre> |
| <div class="block">Sets the data policy for the next <code>RegionAttributes</code> created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataPolicy</code> - The type of mirroring to use for the region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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 dataPolicy is null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDataPolicy-org.apache.geode.cache.DataPolicy-"><code>AttributesFactory.setDataPolicy(org.apache.geode.cache.DataPolicy)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEarlyAck-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEarlyAck</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setEarlyAck(boolean earlyAck)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of 6.5 this setting no longer has any effect.</span></div> |
| <div class="block">Sets for this region whether or not acks are sent after an update is processed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>earlyAck</code> - set to true for the acknowledgement to be sent prior to processing the update</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setEarlyAck-boolean-"><code>AttributesFactory.setEarlyAck(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMulticastEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMulticastEnabled</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setMulticastEnabled(boolean value)</pre> |
| <div class="block">Sets whether distributed operations on this region should attempt to use multicast.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - true to enable multicast</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setMulticastEnabled-boolean-"><code>AttributesFactory.setMulticastEnabled(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPoolName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPoolName</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setPoolName(<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> poolName)</pre> |
| <div class="block">Sets the pool name attribute. This causes regions that use these attributes to be a client |
| region which communicates with the servers that the connection pool communicates with. |
| <p> |
| If this attribute is set to <code>null</code> or <code>""</code> then the connection pool is disabled |
| causing regions that use these attributes to be communicate with peers instead of servers. |
| <p> |
| The named connection pool must exist on the cache at the time these attributes are used to |
| create a region. See <a href="../../../../org/apache/geode/cache/client/PoolManager.html#createFactory--"><code>PoolManager.createFactory()</code></a> for how to create a connection pool.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>poolName</code> - the name of the connection pool to use; if <code>null</code> or <code>""</code> then the |
| connection pool attribute is disabled for regions using these attributes.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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 a cache loader or cache writer has already been set.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPublisher-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPublisher</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public void setPublisher(boolean v)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5</span></div> |
| <div class="block">Sets whether or not this region should be considered a publisher.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>v</code> - whether this region should be considered a publisher</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEnableAsyncConflation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnableAsyncConflation</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setEnableAsyncConflation(boolean value)</pre> |
| <div class="block">Sets whether or not conflation is enabled for sending messages to async peers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - true to enable async conflation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setEnableAsyncConflation-boolean-"><code>AttributesFactory.setEnableAsyncConflation(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEnableSubscriptionConflation-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnableSubscriptionConflation</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setEnableSubscriptionConflation(boolean value)</pre> |
| <div class="block">Sets whether or not conflation is enabled for sending messages from a cache server to its |
| clients.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - true to enable subscription conflation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setEnableSubscriptionConflation-boolean-"><code>AttributesFactory.setEnableSubscriptionConflation(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setKeyConstraint-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyConstraint</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setKeyConstraint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>> keyConstraint)</pre> |
| <div class="block">Sets the key constraint for the next <code>RegionAttributes</code> created. Keys in the region will |
| be constrained to this class (or subclass). Any attempt to store a key of an incompatible type |
| in the region will cause a <code>ClassCastException</code> to be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyConstraint</code> - The Class to constrain the keys to, or null if no constraint</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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>keyConstraint</code> is a class denoting a primitive type</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setKeyConstraint-java.lang.Class-"><code>AttributesFactory.setKeyConstraint(java.lang.Class<K>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueConstraint-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueConstraint</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setValueConstraint(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> valueConstraint)</pre> |
| <div class="block">Sets the value constraint for the next <code>RegionAttributes</code> created. Values in the region |
| will be constrained to this class (or subclass). Any attempt to store a value of an |
| incompatible type in the region will cause a <code>ClassCastException</code> to be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueConstraint</code> - The Class to constrain the values to, or null if no constraint</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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>valueConstraint</code> is a class denoting a primitive |
| type</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setValueConstraint-java.lang.Class-"><code>AttributesFactory.setValueConstraint(java.lang.Class<V>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialCapacity-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialCapacity</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setInitialCapacity(int initialCapacity)</pre> |
| <div class="block">Sets the entry initial capacity for the next <code>RegionAttributes</code> created. This value is |
| used in initializing the map that holds the entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - the initial capacity of the entry map</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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 initialCapacity is negative.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util"><code>HashMap</code></a>, |
| <a href="../../../../org/apache/geode/cache/AttributesFactory.html#setInitialCapacity-int-"><code>AttributesFactory.setInitialCapacity(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLoadFactor-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLoadFactor</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setLoadFactor(float loadFactor)</pre> |
| <div class="block">Sets the entry load factor for the next <code>RegionAttributes</code> created. This value is used in |
| initializing the map that holds the entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loadFactor</code> - the load factor of the entry map</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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 loadFactor is nonpositive</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util"><code>HashMap</code></a>, |
| <a href="../../../../org/apache/geode/cache/AttributesFactory.html#setLoadFactor-float-"><code>AttributesFactory.setLoadFactor(float)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConcurrencyLevel-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConcurrencyLevel</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setConcurrencyLevel(int concurrencyLevel)</pre> |
| <div class="block">Sets the concurrency level tof the next <code>RegionAttributes</code> created. This value is used in |
| initializing the map that holds the entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>concurrencyLevel</code> - the concurrency level of the entry map</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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 concurrencyLevel is nonpositive</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setConcurrencyLevel-int-"><code>AttributesFactory.setConcurrencyLevel(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConcurrencyChecksEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConcurrencyChecksEnabled</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setConcurrencyChecksEnabled(boolean enabled)</pre> |
| <div class="block">Enables a versioning system that detects concurrent modifications and ensures that region |
| contents are consistent across the distributed system. This setting must be the same in each |
| member having the region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabled</code> - whether concurrency checks should be enabled for the region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setConcurrencyChecksEnabled-boolean-"><code>AttributesFactory.setConcurrencyChecksEnabled(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskWriteAttributes-org.apache.geode.cache.DiskWriteAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiskWriteAttributes</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setDiskWriteAttributes(<a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html" title="interface in org.apache.geode.cache">DiskWriteAttributes</a> attrs)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/RegionFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> instead</span></div> |
| <div class="block">Sets the <a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html" title="interface in org.apache.geode.cache"><code>DiskWriteAttributes</code></a> for this factory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attrs</code> - the <a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html" title="interface in org.apache.geode.cache"><code>DiskWriteAttributes</code></a> to be set for this factory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/Region.html#writeToDisk--"><code>Region.writeToDisk()</code></a>, |
| <a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskWriteAttributes-org.apache.geode.cache.DiskWriteAttributes-"><code>AttributesFactory.setDiskWriteAttributes(org.apache.geode.cache.DiskWriteAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskStoreName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiskStoreName</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setDiskStoreName(<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> name)</pre> |
| <div class="block">Sets the DiskStore name attribute. This causes the region to belong to the DiskStore.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the diskstore</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-"><code>AttributesFactory.setDiskStoreName(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskSynchronous-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiskSynchronous</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setDiskSynchronous(boolean isSynchronous)</pre> |
| <div class="block">Sets whether or not the writing to the disk is synchronous.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isSynchronous</code> - boolean if true indicates synchronous writes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskDirs-java.io.File:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiskDirs</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setDiskDirs(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] diskDirs)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskDirs-java.io.File:A-"><code>DiskStoreFactory.setDiskDirs(java.io.File[])</code></a> instead</span></div> |
| <div class="block">Sets the directories to which the region's data are written. If multiple directories are used, |
| GemFire will attempt to distribute the data evenly amongst them.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>diskDirs</code> - the directories to which the region's data is written</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskDirs-java.io.File:A-"><code>AttributesFactory.setDiskDirs(java.io.File[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskDirsAndSizes-java.io.File:A-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiskDirsAndSizes</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setDiskDirsAndSizes(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] diskDirs, |
| int[] diskSizes)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-"><code>DiskStoreFactory.setDiskDirsAndSizes(java.io.File[], int[])</code></a> instead</span></div> |
| <div class="block">Sets the directories to which the region's data are written and also set their sizes in |
| megabytes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>diskDirs</code> - the directories to which the region's data is written</dd> |
| <dd><code>diskSizes</code> - the size in megabytes for each directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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 length of the size array does not match to the length of |
| the dir array</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-"><code>AttributesFactory.setDiskDirsAndSizes(java.io.File[], int[])</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPartitionAttributes-org.apache.geode.cache.PartitionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitionAttributes</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setPartitionAttributes(<a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache">PartitionAttributes</a> partition)</pre> |
| <div class="block">Sets the <code>PartitionAttributes</code> that describe how the region is partitioned among members |
| of the distributed system.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>partition</code> - the <code>PartitionAttributes</code> that describe how the region is partitioned |
| among members of the distributed system</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setPartitionAttributes-org.apache.geode.cache.PartitionAttributes-"><code>AttributesFactory.setPartitionAttributes(org.apache.geode.cache.PartitionAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMembershipAttributes-org.apache.geode.cache.MembershipAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMembershipAttributes</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setMembershipAttributes(<a href="../../../../org/apache/geode/cache/MembershipAttributes.html" title="class in org.apache.geode.cache">MembershipAttributes</a> ra)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">this API is scheduled to be removed</span></div> |
| <div class="block">Sets the <code>MembershipAttributes</code> that describe the membership roles required for reliable |
| access to the region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ra</code> - the MembershipAttributes to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setMembershipAttributes-org.apache.geode.cache.MembershipAttributes-"><code>AttributesFactory.setMembershipAttributes(org.apache.geode.cache.MembershipAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIndexMaintenanceSynchronous-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndexMaintenanceSynchronous</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setIndexMaintenanceSynchronous(boolean synchronous)</pre> |
| <div class="block">Sets how indexes on this region are kept current.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>synchronous</code> - whether indexes are maintained in a synchronized fashion</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStatisticsEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatisticsEnabled</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setStatisticsEnabled(boolean statisticsEnabled)</pre> |
| <div class="block">Sets whether statistics are enabled for this region and its entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statisticsEnabled</code> - whether statistics are enabled</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</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="setIgnoreJTA-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreJTA</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setIgnoreJTA(boolean flag)</pre> |
| <div class="block">Sets whether operations on this region should be controlled by JTA transactions or not</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - whether operations on this region should be controlled by JTA transactions</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLockGrantor-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockGrantor</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setLockGrantor(boolean isLockGrantor)</pre> |
| <div class="block">Sets whether this region should become lock grantor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isLockGrantor</code> - whether this region should become lock grantor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setLockGrantor-boolean-"><code>AttributesFactory.setLockGrantor(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSubscriptionAttributes-org.apache.geode.cache.SubscriptionAttributes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubscriptionAttributes</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setSubscriptionAttributes(<a href="../../../../org/apache/geode/cache/SubscriptionAttributes.html" title="class in org.apache.geode.cache">SubscriptionAttributes</a> sa)</pre> |
| <div class="block">Sets the kind of interest this region has in events occuring in other caches that define the |
| region by the same name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sa</code> - the attributes decribing the interest</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setSubscriptionAttributes-org.apache.geode.cache.SubscriptionAttributes-"><code>AttributesFactory.setSubscriptionAttributes(SubscriptionAttributes)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> create(<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> name) |
| throws <a href="../../../../org/apache/geode/cache/CacheExistsException.html" title="class in org.apache.geode.cache">CacheExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a>, |
| <a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a>, |
| <a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></pre> |
| <div class="block">Creates a region with the given name in this factory's <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> using the configuration |
| contained in this factory. Validation of the provided attributes may cause exceptions to be |
| thrown if there are problems with the configuration data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the region to create</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/distributed/LeaseExpiredException.html" title="class in org.apache.geode.distributed">LeaseExpiredException</a></code> - if lease expired on distributed lock for Scope.GLOBAL</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code> - if a region, shared or unshared, is already in this cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/TimeoutException.html" title="class in org.apache.geode.cache">TimeoutException</a></code> - if timed out getting distributed lock for Scope.GLOBAL</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache">CacheClosedException</a></code> - if the cache is closed</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 the supplied RegionAttributes are incompatible with this |
| region in another cache in the distributed system (see <a href="../../../../org/apache/geode/cache/AttributesFactory.html" title="class in org.apache.geode.cache"><code>AttributesFactory</code></a> for |
| compatibility rules)</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheExistsException.html" title="class in org.apache.geode.cache">CacheExistsException</a></code></dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheWriterException.html" title="class in org.apache.geode.cache">CacheWriterException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSubregion-org.apache.geode.cache.Region-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSubregion</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> createSubregion(<a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><?,?> parent, |
| <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> name) |
| throws <a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></pre> |
| <div class="block">Creates a sub-region in the <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>Cache</code></a> using the configuration contained in this |
| RegionFactory. Validation of the provided attributes may cause exceptions to be thrown if there |
| are problems with the configuration data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parent</code> - the existing region that will contain the created sub-region</dd> |
| <dd><code>name</code> - the name of the region to create</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the region object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache">RegionExistsException</a></code> - if a region with the given name already exists in this cache</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/RegionDestroyedException.html" title="class in org.apache.geode.cache">RegionDestroyedException</a></code> - if the parent region has been closed or destroyed</dd> |
| <dd><code><a href="../../../../org/apache/geode/cache/CacheClosedException.html" title="class in org.apache.geode.cache">CacheClosedException</a></code> - if the cache is closed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCloningEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCloningEnabled</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> 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="paramLabel">Parameters:</span></dt> |
| <dd><code>cloningEnable</code> - whether cloning is enabled for the region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setCloningEnabled-boolean-"><code>AttributesFactory.setCloningEnabled(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addGatewaySenderId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addGatewaySenderId</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> 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 a gatewaySenderId to the RegionAttributes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>gatewaySenderId</code> - the gatewaySenderId to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory object</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#addGatewaySenderId-java.lang.String-"><code>AttributesFactory.addGatewaySenderId(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAsyncEventQueueId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAsyncEventQueueId</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> 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 a asyncEventQueueId to the RegionAttributes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>asyncEventQueueId</code> - id of AsyncEventQueue</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCompressor-org.apache.geode.compression.Compressor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompressor</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setCompressor(<a href="../../../../org/apache/geode/compression/Compressor.html" title="interface in org.apache.geode.compression">Compressor</a> compressor)</pre> |
| <div class="block">Set the compressor to be used by this region for compressing region entry values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compressor</code> - a compressor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOffHeap-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setOffHeap</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionFactory.html" title="class in org.apache.geode.cache">RegionFactory</a><<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">K</a>,<a href="../../../../org/apache/geode/cache/RegionFactory.html" title="type parameter in RegionFactory">V</a>> setOffHeap(boolean offHeap)</pre> |
| <div class="block">Enables this region's usage of off-heap memory if true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>offHeap</code> - boolean flag to enable off-heap memory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this RegionFactory instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/RegionExistsException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/RegionMembershipListener.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/RegionFactory.html" target="_top">Frames</a></li> |
| <li><a href="RegionFactory.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> |
