http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/AttributesFactory.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/AttributesFactory.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/AttributesFactory.html new file mode 100644 index 0000000..bccee92 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/AttributesFactory.html @@ -0,0 +1,2018 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>AttributesFactory (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="AttributesFactory (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42,"i13":42,"i14":42,"i15":42,"i16":42,"i17":42,"i18":42,"i19":42,"i20":42,"i21":42,"i22":42,"i23":42,"i24":42,"i25":42,"i26":42,"i27":42,"i28":42,"i29":42,"i30":42,"i31":42,"i32":42,"i33":42,"i34":42,"i35":42,"i36":42,"i37":42,"i38":42,"i39":42,"i40":42,"i41":42,"i42":42,"i43":42,"i44":42,"i45":42,"i46":42,"i47":42,"i48":42,"i49":42,"i50":42,"i51":41}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> +<li><a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/AttributesFactory.html" target="_top">Frames</a></li> +<li><a href="AttributesFactory.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><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire.cache</div> +<h2 title="Class AttributesFactory" class="title">Class AttributesFactory<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.AttributesFactory<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../com/gemstone/gemfire/cache/Cache.html#createRegionFactory-com.gemstone.gemfire.cache.RegionShortcut-"><code>Cache.createRegionFactory(RegionShortcut)</code></a> or <a href="../../../../com/gemstone/gemfire/cache/client/ClientCache.html#createClientRegionFactory-com.gemstone.gemfire.cache.client.ClientRegionShortcut-"><code>ClientCache.createClientRegionFactory(ClientRegionShortcut)</code></a> instead.</span></div> +</div> +<br> +<pre>public class <span class="typeNameLabel">AttributesFactory<K,V></span> +extends java.lang.Object</pre> +<div class="block">Creates instances of <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>RegionAttributes</code></a>. An <code>AttributesFactory</code> + instance maintains state for creating <code>RegionAttributes</code> instances. + The setter methods are used to change the settings that will be used for + creating the next attributes instance with the <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#create--"><code>create()</code></a> + method. If you create a factory with the default constructor, then the + factory is set up to create attributes with all default settings. You can + also create a factory by providing a <code>RegionAttributes</code>, which + will set up the new factory with the settings provided in that attributes + instance. + + <p>Once a <code>RegionAttributes</code> is created, it can only be modified + after it has been used to create a <code>Region</code>, and then only by + using an <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><code>AttributesMutator</code></a> obtained from the region. + + <h3>Attributes</h3> + <h4>Callbacks</h4> + <dl> + <dt><a href="../../../../com/gemstone/gemfire/cache/CacheLoader.html" title="interface in com.gemstone.gemfire.cache"><code>CacheLoader</code></a> [<em>default:</em> <code>null</code>, meaning no loader]</dt> + <dd>User-implemented plug-in for loading data on cache misses.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCacheLoader-com.gemstone.gemfire.cache.CacheLoader-"><code>setCacheLoader(com.gemstone.gemfire.cache.CacheLoader<K, V>)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getCacheLoader--"><code>RegionAttributes.getCacheLoader()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setCacheLoader-com.gemstone.gemfire.cache.CacheLoader-"><code>AttributesMutator.setCacheLoader(com.gemstone.gemfire.cache.CacheLoader<K, V>)</code></a></dd> + + <dt><a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache"><code>CacheWriter</code></a> [<em>default:</em> <code>null</code>, meaning no writer]</dt> + <dd>User-implemented plug-in for intercepting cache modifications, e.g. + for writing to an external data source.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCacheWriter-com.gemstone.gemfire.cache.CacheWriter-"><code>setCacheWriter(com.gemstone.gemfire.cache.CacheWriter<K, V>)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getCacheWriter--"><code>RegionAttributes.getCacheWriter()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setCacheWriter-com.gemstone.gemfire.cache.CacheWriter-"><code>AttributesMutator.setCacheWriter(com.gemstone.gemfire.cache.CacheWriter<K, V>)</code></a></dd> + + <dt><a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache"><code>CacheListener</code></a> [<em>default:</em> <code>null</code>, meaning no listener ]</dt> + <dd>User-implemented plug-in for receiving and handling cache related events.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#addCacheListener-com.gemstone.gemfire.cache.CacheListener-"><code>addCacheListener(com.gemstone.gemfire.cache.CacheListener<K, V>)</code></a> <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#initCacheListeners-com.gemstone.gemfire.cache.CacheListener:A-"><code>initCacheListeners(com.gemstone.gemfire.cache.CacheListener<K, V>[])</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#initCacheListeners-com.gemstone.gemfire.cache.CacheListener:A-"><code>initCacheListeners(com.gemstone.gemfire.cache.CacheListener<K, V>[])</code></a> + <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getCacheListeners--"><code>RegionAttributes.getCacheListeners()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#initCacheListeners-com.gemstone.gemfire.cache.CacheListener:A-"><code>AttributesMutator.initCacheListeners(com.gemstone.gemfire.cache.CacheListener<K, V>[])</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#addCacheListener-com.gemstone.gemfire.cache.CacheListener-"><code>AttributesMutator.addCacheListener(com.gemstone.gemfire.cache.CacheListener<K, V>)</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#removeCacheListener-com.gemstone.gemfire.cache.CacheListener-"><code>AttributesMutator.removeCacheListener(com.gemstone.gemfire.cache.CacheListener<K, V>)</code></a></dd> + </dl> + <h4>Expiration</h4> + <dl> + <dt>RegionTimeToLive [<em>default:</em> no expiration]</dt> + <dd>Expiration configuration for the entire region based on the + <a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastModifiedTime--"><code>lastModifiedTime</code></a>.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setRegionTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>setRegionTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getRegionTimeToLive--"><code>RegionAttributes.getRegionTimeToLive()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setRegionTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>AttributesMutator.setRegionTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a></dd> + + <dt>RegionIdleTimeout [<em>default:</em> no expiration]</dt> + <dd>Expiration configuration for the entire region based on the + <a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastAccessedTime--"><code>lastAccessedTime</code></a>.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setRegionIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>setRegionIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getRegionIdleTimeout--"><code>RegionAttributes.getRegionIdleTimeout()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setRegionIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>AttributesMutator.setRegionIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a></dd> + + <dt>EntryTimeToLive [<em>default:</em> no expiration]</dt> + <dd>Expiration configuration for individual entries based on the + <a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastModifiedTime--"><code>lastModifiedTime</code></a>.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEntryTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>setEntryTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getEntryTimeToLive--"><code>RegionAttributes.getEntryTimeToLive()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setEntryTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>AttributesMutator.setEntryTimeToLive(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a></dd> + + <dt>EntryIdleTimeout [<em>default:</em> no expiration]</dt> + <dd>Expiration configuration for individual entries based on the + <a href="../../../../com/gemstone/gemfire/cache/CacheStatistics.html#getLastAccessedTime--"><code>lastAccessedTime</code></a>.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEntryIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>setEntryIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getEntryIdleTimeout--"><code>RegionAttributes.getEntryIdleTimeout()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#setEntryIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-"><code>AttributesMutator.setEntryIdleTimeout(com.gemstone.gemfire.cache.ExpirationAttributes)</code></a></dd> + </dl> + <h4>Distribution</h4> + <dl> + <dt><a href="../../../../com/gemstone/gemfire/cache/Scope.html" title="class in com.gemstone.gemfire.cache"><code>Scope</code></a>[<em>default:</em> <a href="../../../../com/gemstone/gemfire/cache/Scope.html#DISTRIBUTED_NO_ACK"><code>Scope.DISTRIBUTED_NO_ACK</code></a>] + </dt> + <dd>Properties of distribution for the region, including whether it is + distributed at all, whether acknowledgements are required, and whether + distributed synchronization is required. <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setScope-com.gemstone.gemfire.cache.Scope-"><code>setScope(com.gemstone.gemfire.cache.Scope)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getScope--"><code>RegionAttributes.getScope()</code></a></dd> + + <dt>EarlyAck [<em>default:</em> <code>false</code>]</dt> + <dd>Whether or not acks required by <code>Scope.DISTRIBUTED_ACK</code> + are sent after an operation is processed. If <code>true</code> + then remote caches will ACK before processing an operation sent + by the cache that has set earlyAck to <code>true</code>. + Note that this attribute is only meaningful on the cache that + is initiating an operation; it does not matter what it is set to + on the cache that receives the operation.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEarlyAck-boolean-"><code>setEarlyAck(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getEarlyAck--"><code>RegionAttributes.getEarlyAck()</code></a></dd> + + <dt><a href="../../../../com/gemstone/gemfire/cache/SubscriptionAttributes.html" title="class in com.gemstone.gemfire.cache"><code>SubscriptionAttributes</code></a> [<em>default:</em> <a href="../../../../com/gemstone/gemfire/cache/InterestPolicy.html#DEFAULT"><code>InterestPolicy.DEFAULT</code></a>]</dt> + <dd>How will the region in this cache subscribe to other distributed + instances of this region. + <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setSubscriptionAttributes-com.gemstone.gemfire.cache.SubscriptionAttributes-"><code>setSubscriptionAttributes(com.gemstone.gemfire.cache.SubscriptionAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getSubscriptionAttributes--"><code>RegionAttributes.getSubscriptionAttributes()</code></a></dd> + + <dt>EnableAsyncConflation [<em>default:</em> <code>false</code>]</dt> + <dd>Whether or not conflation is enabled for sending + messages to async peers. Async peers are those whose + <code>async-distribution-timeout</code> gemfire.property is greater + than zero. AsyncConflation is ignored if the scope is + <code>DISTRIBUTED_ACK</code> or <code>GLOBAL</code>. + Conflation is only done on entry update operations. It is done + by dropping the earlier update from the message queue. + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableAsyncConflation-boolean-"><code>setEnableAsyncConflation(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getEnableAsyncConflation--"><code>RegionAttributes.getEnableAsyncConflation()</code></a></dd> + <dt>poolName [<em>default:</em> <code>null</code>, meaning no pool]</dt> + <dd>Whether or not this region is a client that is to use + connections from the named pool to communicate with servers. + If <code>null</code>, then it is not a client. + If <code>non-null</code>, then the named pool will be used. + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPoolName-java.lang.String-"><code>setPoolName(java.lang.String)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getPoolName--"><code>RegionAttributes.getPoolName()</code></a></dd> + + + <dt>EnableSubscriptionConflation [<em>default:</em> <code>false</code>]</dt> + <dd>Whether or not conflation is enabled for sending + messages from a cache server to its clients. Note: This parameter + is only valid for cache server to client communication. It has no + effect in peer to peer communication. + If <code>true</code>, messages will be conflated before they are + sent from a cache server to its clients. Only the latest value + will be sent. + Note that this attribute is only meaningful in a client server + topology. + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableSubscriptionConflation-boolean-"><code>setEnableSubscriptionConflation(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getEnableSubscriptionConflation--"><code>RegionAttributes.getEnableSubscriptionConflation()</code></a></dd> + <dt>Publisher [<em>default:</em> <code>false</code>]</dt> + <dd>Whether or not a region is a publisher. Publishers are regions + that will have distributed write operations done on them. + If a publisher is also a replicate then it will be used + as the preferred source for initializing other replicates. + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPublisher-boolean-"><code>setPublisher(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getPublisher--"><code>RegionAttributes.getPublisher()</code></a></dd> + <dt>isCloningEnabled [<em>default:</em> <code>false</code>]</dt> + <dd>Whether or not value is cloned before appling <code>Delta</code>s + If <code>false</code>, value will not be cloned + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCloningEnabled-boolean-"><code>setCloningEnabled(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getCloningEnabled--"><code>RegionAttributes.getCloningEnabled()</code></a></dd></dt> + </dl> + <h4>Storage (see also <a href="package-summary.html#storage">package summary + </a>)</h4> + <dl> + <dt><a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache"><code>DataPolicy</code></a> [<em>default:</em> <code>DataPolicy.NORMAL</code>]</dt> + <dd>Specifies the data storage policy.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDataPolicy-com.gemstone.gemfire.cache.DataPolicy-"><code>setDataPolicy(com.gemstone.gemfire.cache.DataPolicy)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getDataPolicy--"><code>RegionAttributes.getDataPolicy()</code></a></dd> + + <dt><a href="../../../../com/gemstone/gemfire/cache/MirrorType.html" title="class in com.gemstone.gemfire.cache"><code>MirrorType</code></a> [<em>default:</em> <code>MirrorType.NONE</code>]</dt> + <dd><em>Deprecated</em>, use DataPolicy instead.</dd> + + <dt><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEvictionAttributes-com.gemstone.gemfire.cache.EvictionAttributes-"><code>EvictionAttributes</code></a></dt> + <dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAttributes</code></a> are the replacement for the deprecated and removed CapacityController interface. + EvictionAttributes describe the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> and the <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAction</code></a> + as well as the various conditions under which the algorithm perform the action + e.g. when the maximum number of entries has been reached or + the maximum percentage of JVM heap has been consumed. + Setting <code>EvictionAttributes</code> installs an eviction controller + on the Region instantiated with the associated RegionAttributes </dd> + + <dt>KeyConstraint [<em>default:</em> <code>null</code>, meaning no constraint]</dt> + <dd>The Class to constrain the keys to in the region.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setKeyConstraint-java.lang.Class-"><code>setKeyConstraint(java.lang.Class<K>)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getKeyConstraint--"><code>RegionAttributes.getKeyConstraint()</code></a></dd> + + <dt>ValueConstraint [<em>default:</em> <code>null</code>, meaning no constraint]</dt> + <dd>The Class to constrain the values to in the region. In addition to the + utility of this for applications in general, a <code>valueConstraint</code> + is helpful for compiling queries.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setValueConstraint-java.lang.Class-"><code>setValueConstraint(java.lang.Class<V>)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getValueConstraint--"><code>RegionAttributes.getValueConstraint()</code></a></dd> + + <dt>InitialCapacity [<em>default:</em> <code>16</code>]</dt> + <dd>The initial capacity of the map used for storing the entries. <br> + <code>HashMap</code> <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setInitialCapacity-int-"><code>setInitialCapacity(int)</code></a> + <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getInitialCapacity--"><code>RegionAttributes.getInitialCapacity()</code></a></dd> + + <dt>LoadFactor [<em>default:</em> <code>0.75</code>]</dt> + <dd>The load factor of the map used for storing the entries. <br> + <code>HashMap</code> <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setLoadFactor-float-"><code>setLoadFactor(float)</code></a> + <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getLoadFactor--"><code>RegionAttributes.getLoadFactor()</code></a></dd> + + <dt>ConcurrencyLevel [<em>default:</em> <code>16</code>]</dt> + <dd>The allowed concurrency among updates to values in the region is guided + by the <tt>concurrencyLevel</tt>, which is used as a hint for internal + sizing. The actual concurrency will vary. Ideally, you should choose a value + to accommodate as many threads as will ever concurrently modify values in the + region. Using a significantly higher value than you need can waste space and + time, and a significantly lower value can lead to thread contention. But + overestimates and underestimates within an order of magnitude do not usually + have much noticeable impact. A value of one is appropriate when it is known + that only one thread will modify and all others will only read. <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setConcurrencyLevel-int-"><code>setConcurrencyLevel(int)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getConcurrencyLevel--"><code>RegionAttributes.getConcurrencyLevel()</code></a> + </dd> + + <dt>ConcurrencyChecksEnabled [<em>default:</em> <code>false</code>]</dt> + <dd>Enables a distributed versioning algorithm that detects concurrency + conflicts in regions and ensures that changes to an + entry are not applied in a different order in other members. This can + cause operations to be conflated, so that some cache listeners may see + an event while others do not, but it guarantees that the system will + be consistent. + </dd> + + <dt>StatisticsEnabled [<em>default:</em> <code>false</code>]</dt> + <dd>Whether statistics are enabled for this region. The default is disabled, + which conserves on memory. <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setStatisticsEnabled-boolean-"><code>setStatisticsEnabled(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getStatisticsEnabled--"><code>RegionAttributes.getStatisticsEnabled()</code></a> + </dd> + + <dt>IgnoreJTA [<em>default:</em> <code>false</code>]</dt> + <dd>Whether JTA transactions are ignored for this region. The + default is to look for and join JTA transactions for operations + performed on a region. + + <dt>DiskStoreName [<em>default:</em> <code>null</code>, meaning no disk store]</dt> + <dd>If not <code>null</code> then this region will write its data + to the named <a href="../../../../com/gemstone/gemfire/cache/DiskStore.html" title="interface in com.gemstone.gemfire.cache"><code>DiskStore</code></a>.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getDiskStoreName--"><code>RegionAttributes.getDiskStoreName()</code></a></dd> + + <dt>DiskSynchronous [<em>default:</em> <code>true</code>]</dt> + <dd>If <code>true</code> then any writes to disk done for this region + will be done synchronously. This means that they will be in the file system + buffer before the operation doing the write returns.<br> + If <code>false</code> then any writes to disk done for this region + will be done asynchronously. This means that they are queued up to be written + and when they are actually written to the file system buffer is determined + by the region's <a href="../../../../com/gemstone/gemfire/cache/DiskStore.html" title="interface in com.gemstone.gemfire.cache"><code>DiskStore</code></a> configuration. + Asynchronous writes will be conflated if the same entry is written while a + previous operation for the same entry is still in the queue.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskSynchronous-boolean-"><code>setDiskSynchronous(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#isDiskSynchronous--"><code>RegionAttributes.isDiskSynchronous()</code></a></dd> + + <dt>PersistBackup [<em>default:</em> <code>false</code>]</dt> + <dd>Whether or not a persistent backup should be made of the + region.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPersistBackup-boolean-"><code>setPersistBackup(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getPersistBackup--"><code>RegionAttributes.getPersistBackup()</code></a></dd> + <dd><em>Deprecated</em>, use <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>DataPolicy.PERSISTENT_REPLICATE</code></a> or <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>DataPolicy.PERSISTENT_PARTITION</code></a> instead.</dd> + + <dt>DiskWriteAttributes [<em>default:</em> Asynchronously write to + disk every second (a <code>timeInterval</code> of 1000 and a + <code>byteThreshold</codE> of 0). <code>rollOplogs</code> is set to true and + <code>maxOplogSize</code> is set to 1024 MB]</dt> + <dd>How region data should be written to disk. Determines + whether data should be written synchronously or asynchronously. + Data that is written asynchronously can be written at a certain + <a href="../../../../com/gemstone/gemfire/cache/DiskWriteAttributes.html#getTimeInterval--">time interval</a> + or once a certain number of <a href="../../../../com/gemstone/gemfire/cache/DiskWriteAttributes.html#getBytesThreshold--">bytes of data</a> have been + enqueued.<br> + <a href="../../../../com/gemstone/gemfire/cache/DiskWriteAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>DiskWriteAttributes</code></a> <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskWriteAttributes-com.gemstone.gemfire.cache.DiskWriteAttributes-"><code>setDiskWriteAttributes(com.gemstone.gemfire.cache.DiskWriteAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getDiskWriteAttributes--"><code>RegionAttributes.getDiskWriteAttributes()</code></a></dd> + <dd><em>Deprecated</em>, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> and <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskSynchronous-boolean-"><code>setDiskSynchronous(boolean)</code></a> instead.</dd> + + <dt>DiskDirs [<em>default:</em> Current working directory (<code>user.dir</code> system property)]</dt> + <dd>The directories to which the region's data are written. If + multiple directories are used, GemFire will attempt to distribute the + data evenly among them. <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskDirs-java.io.File:A-"><code>setDiskDirs(java.io.File[])</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getDiskDirs--"><code>RegionAttributes.getDiskDirs()</code></a></dd> + <dd><em>Deprecated</em>, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> instead.</dd> + + <dt>DiskDirSizes [<em>default:</em> 10240 MB]</dt> + <dd> The size of the directory to which region's data is written.<br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-"><code>setDiskDirsAndSizes(java.io.File[], int[])</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getDiskDirSizes--"><code>RegionAttributes.getDiskDirSizes()</code></a></dd> + <dd><em>Deprecated</em>, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> instead.</dd> + + + <dt><a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a> [<em>default:</em> <code>null</code>, meaning no region partitioning]</dt> + <dd>How region data is partitioned among the members of the + distributed system. + <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPartitionAttributes-com.gemstone.gemfire.cache.PartitionAttributes-"><code>setPartitionAttributes(com.gemstone.gemfire.cache.PartitionAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getPartitionAttributes--"><code>RegionAttributes.getPartitionAttributes()</code></a></dd> + + <dt><a href="../../../../com/gemstone/gemfire/cache/MembershipAttributes.html" title="class in com.gemstone.gemfire.cache"><code>MembershipAttributes</code></a> [<em>default:</em> no required roles]</dt> + <dd>How access to the region is affected when one or more required roles + are missing from the region membership. + <br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setMembershipAttributes-com.gemstone.gemfire.cache.MembershipAttributes-"><code>setMembershipAttributes(com.gemstone.gemfire.cache.MembershipAttributes)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getMembershipAttributes--"><code>RegionAttributes.getMembershipAttributes()</code></a></dd> + + </dt> + </dl> + + <h4>Locking</h4> + <dl> + <dt>LockGrantor [<em>default:</em> <code>false</code>]</dt> + <dd>Should this process become lock grantor for the region?</dd><br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setLockGrantor-boolean-"><code>setLockGrantor(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#isLockGrantor--"><code>RegionAttributes.isLockGrantor()</code></a> + <a href="../../../../com/gemstone/gemfire/cache/Region.html#becomeLockGrantor--"><code>Region.becomeLockGrantor()</code></a> + </dl> + + <h4>Querying</h4> + <dl> + <dt>IndexMaintenanceSynchronous [<em>default:</em> <code>false</code>]</dt> + <dd>Are indexes built over in this region updated + synchronously when the underlying data is + modified?</dd><br> + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setIndexMaintenanceSynchronous-boolean-"><code>setIndexMaintenanceSynchronous(boolean)</code></a> <a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html#getIndexMaintenanceSynchronous--"><code>RegionAttributes.getIndexMaintenanceSynchronous()</code></a> + </dl> + + <p>Note that the RegionAttributes are not distributed with the region. + + <a name="compatibility"><h3>Compatibility Rules</h3> + <h4>RegionAttributes Creation Constraints</h4> + If any of the following compatibility rules are violated when + <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#create--"><code>create()</code></a></code> is called then an + <code>IllegalStateException</code> is thrown. + See <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#validateAttributes-com.gemstone.gemfire.cache.RegionAttributes-"><code>validateAttributes(com.gemstone.gemfire.cache.RegionAttributes<?, ?>)</code></a>. + + <a name="creationConstraints"><h3>Creation Constraints</h3> + <h4>Region Creation Constraints on RegionAttributes</h4> + + If any of the following rules are violated when <a href="../../../../com/gemstone/gemfire/cache/Region.html#createSubregion-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-"><code>createSubregion</code></a> or <a href="../../../../com/gemstone/gemfire/cache/Cache.html#createRegion-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-"><code>createRegion</code></a> are called, then an + <code>IllegalStateException</code> is thrown. + + <ul> + <li>A region with <code>Scope.LOCAL</code> can only have subregions with + <code>Scope.LOCAL</code>.</li> + <li><code>Scope.GLOBAL</code> is illegal if there is any other cache in + the distributed system that has the same region with + <code>Scope.DISTRIBUTED_NO_ACK</code> or <code>Scope.DISTRIBUTED_ACK</code>. + </li> + <li><code>Scope.DISTRIBUTED_ACK</code> is illegal if there is any other + cache in the distributed system that has the same region with + <code>Scope.DISTRIBUTED_NO_ACK</code> or <code>Scope.GLOBAL</code>. + </li> + <li><code>Scope.DISTRIBUTED_NO_ACK</code> is illegal if there is any other + cache in the distributed system that has the same region with + <code>Scope.DISTRIBUTED_ACK</code> or <code>Scope.GLOBAL</code>.</li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>RegionAttributes</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><code>AttributesMutator</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/Region.html#createSubregion-java.lang.String-com.gemstone.gemfire.cache.RegionAttributes-"><code>Region.createSubregion(String, RegionAttributes)</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#DEFAULT_DISK_SYNCHRONOUS">DEFAULT_DISK_SYNCHRONOUS</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">The default disk synchronous write setting</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#AttributesFactory--">AttributesFactory</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a new instance of AttributesFactory ready to create a + <code>RegionAttributes</code> with default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#AttributesFactory-com.gemstone.gemfire.cache.RegionAttributes-">AttributesFactory</a></span>(<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> regionAttributes)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a new instance of AttributesFactory ready to create a + <code>RegionAttributes</code> with the same settings as those in the + specified <code>RegionAttributes</code>.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#addAsyncEventQueueId-java.lang.String-">addAsyncEventQueueId</a></span>(java.lang.String asyncEventQueueId)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Adds a AsyncEventQueue to the end of list of async event queues on this factory</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#addCacheListener-com.gemstone.gemfire.cache.CacheListener-">addCacheListener</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache">CacheListener</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> aListener)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#addGatewaySenderId-java.lang.String-">addGatewaySenderId</a></span>(java.lang.String gatewaySenderId)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">adds a gateway sender to the end of list of gateway senders on this factory</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#create--">create</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a <code>RegionAttributes</code> with the current settings.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#createRegionAttributes--">createRegionAttributes</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#create--"><code>create()</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#initCacheListeners-com.gemstone.gemfire.cache.CacheListener:A-">initCacheListeners</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache">CacheListener</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>>[] newListeners)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Removes all cache listeners and then adds each listener in the specified array.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setBucketRegion-boolean-">setBucketRegion</a></span>(boolean b)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCacheListener-com.gemstone.gemfire.cache.CacheListener-">setCacheListener</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache">CacheListener</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> aListener)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#addCacheListener-com.gemstone.gemfire.cache.CacheListener-"><code>addCacheListener(com.gemstone.gemfire.cache.CacheListener<K, V>)</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCacheLoader-com.gemstone.gemfire.cache.CacheLoader-">setCacheLoader</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CacheLoader.html" title="interface in com.gemstone.gemfire.cache">CacheLoader</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> cacheLoader)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCacheWriter-com.gemstone.gemfire.cache.CacheWriter-">setCacheWriter</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache">CacheWriter</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> cacheWriter)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCloningEnabled-boolean-">setCloningEnabled</a></span>(boolean cloningEnable)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets cloning on region.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCompressor-com.gemstone.gemfire.compression.Compressor-">setCompressor</a></span>(<a href="../../../../com/gemstone/gemfire/compression/Compressor.html" title="interface in com.gemstone.gemfire.compression">Compressor</a> compressor)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets this region's compressor for compressing entry values.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setConcurrencyChecksEnabled-boolean-">setConcurrencyChecksEnabled</a></span>(boolean concurrencyChecksEnabled)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Enables or disabled concurrent modification checks.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setConcurrencyLevel-int-">setConcurrencyLevel</a></span>(int concurrencyLevel)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the concurrency level of the next <code>RegionAttributes</code> + created.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCustomEntryIdleTimeout-com.gemstone.gemfire.cache.CustomExpiry-">setCustomEntryIdleTimeout</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="interface in com.gemstone.gemfire.cache">CustomExpiry</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> custom)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the idleTimeout CustomExpiry for the next <code>RegionAttributes</code> + created.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCustomEntryTimeToLive-com.gemstone.gemfire.cache.CustomExpiry-">setCustomEntryTimeToLive</a></span>(<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="interface in com.gemstone.gemfire.cache">CustomExpiry</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> custom)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the custom timeToLive for the next <code>RegionAttributes</code> + created.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setCustomEvictionAttributes-com.gemstone.gemfire.cache.EvictionCriteria-long-long-">setCustomEvictionAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache">EvictionCriteria</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> criteria, + long start, + long interval)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Set custom <a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionCriteria</code></a> for the region with start time and + frequency of evictor task to be run in milliseconds, or evict incoming rows + in case both start and frequency are specified as zero.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDataPolicy-com.gemstone.gemfire.cache.DataPolicy-">setDataPolicy</a></span>(<a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html" title="class in com.gemstone.gemfire.cache">DataPolicy</a> dataPolicy)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the data policy for the next <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskDirs-java.io.File:A-">setDiskDirs</a></span>(java.io.File[] diskDirs)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../com/gemstone/gemfire/cache/DiskStoreFactory.html#setDiskDirs-java.io.File:A-"><code>DiskStoreFactory.setDiskDirs(java.io.File[])</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-">setDiskDirsAndSizes</a></span>(java.io.File[] 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="../../../../com/gemstone/gemfire/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="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-">setDiskStoreName</a></span>(java.lang.String name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the DiskStore name attribute.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskSynchronous-boolean-">setDiskSynchronous</a></span>(boolean isSynchronous)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets whether or not the writing to the disk is synchronous.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskWriteAttributes-com.gemstone.gemfire.cache.DiskWriteAttributes-">setDiskWriteAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/DiskWriteAttributes.html" title="interface in com.gemstone.gemfire.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="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDiskStoreName-java.lang.String-"><code>setDiskStoreName(java.lang.String)</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEarlyAck-boolean-">setEarlyAck</a></span>(boolean earlyAck)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">This setting no longer has any effect.</span></div> +</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableAsyncConflation-boolean-">setEnableAsyncConflation</a></span>(boolean enableAsyncConflation)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets whether or not conflation is enabled for sending messages + to async peers.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableBridgeConflation-boolean-">setEnableBridgeConflation</a></span>(boolean enableBridgeConflation)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 5.7 use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableSubscriptionConflation-boolean-"><code>setEnableSubscriptionConflation(boolean)</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableConflation-boolean-">setEnableConflation</a></span>(boolean enableBridgeConflation)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableSubscriptionConflation-boolean-"><code>setEnableSubscriptionConflation(boolean)</code></a></span></div> +</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEnableSubscriptionConflation-boolean-">setEnableSubscriptionConflation</a></span>(boolean enableSubscriptionConflation)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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="i28" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEntryIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-">setEntryIdleTimeout</a></span>(<a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> idleTimeout)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the idleTimeout expiration attributes for region entries for the next + <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEntryTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-">setEntryTimeToLive</a></span>(<a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> timeToLive)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the timeToLive expiration attributes for region entries for the next + <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEvictionAttributes-com.gemstone.gemfire.cache.EvictionAttributes-">setEvictionAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> evictAttrs)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the EvictionController for the next <code>RegionAttributes</code> + created.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setIgnoreJTA-boolean-">setIgnoreJTA</a></span>(boolean flag)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the flag telling a region to ignore JTA transactions.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setIndexMaintenanceSynchronous-boolean-">setIndexMaintenanceSynchronous</a></span>(boolean synchronous)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Set how indexes on the region should be maintained.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setInitialCapacity-int-">setInitialCapacity</a></span>(int initialCapacity)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the entry initial capacity for the next <code>RegionAttributes</code> + created.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setKeyConstraint-java.lang.Class-">setKeyConstraint</a></span>(java.lang.Class<<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>> keyConstraint)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the key constraint for the next <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setLoadFactor-float-">setLoadFactor</a></span>(float loadFactor)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the entry load factor for the next <code>RegionAttributes</code> + created.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setLockGrantor-boolean-">setLockGrantor</a></span>(boolean isLockGrantor)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets whether this region should become lock grantor.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setMembershipAttributes-com.gemstone.gemfire.cache.MembershipAttributes-">setMembershipAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/MembershipAttributes.html" title="class in com.gemstone.gemfire.cache">MembershipAttributes</a> membership)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the <code>MembershipAttributes</code> that describe the membership + roles required for reliable access to the region.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setMirrorType-com.gemstone.gemfire.cache.MirrorType-">setMirrorType</a></span>(<a href="../../../../com/gemstone/gemfire/cache/MirrorType.html" title="class in com.gemstone.gemfire.cache">MirrorType</a> mirrorType)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setDataPolicy-com.gemstone.gemfire.cache.DataPolicy-"><code>setDataPolicy(com.gemstone.gemfire.cache.DataPolicy)</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setMulticastEnabled-boolean-">setMulticastEnabled</a></span>(boolean value)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets whether distributed operations on this region should attempt + to use multicast.</div> +</td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setOffHeap-boolean-">setOffHeap</a></span>(boolean offHeap)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Enables this region's usage of off-heap memory if true.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPartitionAttributes-com.gemstone.gemfire.cache.PartitionAttributes-">setPartitionAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache">PartitionAttributes</a> partition)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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="i42" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPersistBackup-boolean-">setPersistBackup</a></span>(boolean persistBackup)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>DataPolicy.PERSISTENT_REPLICATE</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPoolName-java.lang.String-">setPoolName</a></span>(java.lang.String name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the pool name attribute.</div> +</td> +</tr> +<tr id="i44" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.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="i45" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setRegionIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-">setRegionIdleTimeout</a></span>(<a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> idleTimeout)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the idleTimeout expiration attributes for the region itself for the + next <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setRegionTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-">setRegionTimeToLive</a></span>(<a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> timeToLive)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the timeToLive expiration attributes for the region itself for the + next <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i47" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setScope-com.gemstone.gemfire.cache.Scope-">setScope</a></span>(<a href="../../../../com/gemstone/gemfire/cache/Scope.html" title="class in com.gemstone.gemfire.cache">Scope</a> scopeType)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the scope for the next <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setStatisticsEnabled-boolean-">setStatisticsEnabled</a></span>(boolean statisticsEnabled)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets whether statistics are enabled for this region and its entries.</div> +</td> +</tr> +<tr id="i49" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setSubscriptionAttributes-com.gemstone.gemfire.cache.SubscriptionAttributes-">setSubscriptionAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/SubscriptionAttributes.html" title="class in com.gemstone.gemfire.cache">SubscriptionAttributes</a> subscription)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the <code>SubscriptionAttributes</code> that describe how the region + will subscribe to other distributed cache instances of the region.</div> +</td> +</tr> +<tr id="i50" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setValueConstraint-java.lang.Class-">setValueConstraint</a></span>(java.lang.Class<<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> valueConstraint)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the value constraint for the next <code>RegionAttributes</code> created.</div> +</td> +</tr> +<tr id="i51" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#validateAttributes-com.gemstone.gemfire.cache.RegionAttributes-">validateAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><?,?> attrs)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Validates that the attributes are consistent with each other.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT_DISK_SYNCHRONOUS"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_DISK_SYNCHRONOUS</h4> +<pre>public static final boolean DEFAULT_DISK_SYNCHRONOUS</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">The default disk synchronous write setting + <p>Current value: <code>true</code> each.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#com.gemstone.gemfire.cache.AttributesFactory.DEFAULT_DISK_SYNCHRONOUS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AttributesFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AttributesFactory</h4> +<pre>public AttributesFactory()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a new instance of AttributesFactory ready to create a + <code>RegionAttributes</code> with default settings.</div> +</li> +</ul> +<a name="AttributesFactory-com.gemstone.gemfire.cache.RegionAttributes-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AttributesFactory</h4> +<pre>public AttributesFactory(<a href="../../../../com/gemstone/gemfire/cache/RegionAttributes.html" title="interface in com.gemstone.gemfire.cache">RegionAttributes</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> regionAttributes)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Creates a new instance of AttributesFactory ready to create a + <code>RegionAttributes</code> with the same settings as those in the + specified <code>RegionAttributes</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>regionAttributes</code> - the <code>RegionAttributes</code> used to initialize this + AttributesFactory</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="setCacheLoader-com.gemstone.gemfire.cache.CacheLoader-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheLoader</h4> +<pre>public void setCacheLoader(<a href="../../../../com/gemstone/gemfire/cache/CacheLoader.html" title="interface in com.gemstone.gemfire.cache">CacheLoader</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> cacheLoader)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this region has a <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPoolName-java.lang.String-"><code>pool name set</code></a></dd> +</dl> +</li> +</ul> +<a name="setCacheWriter-com.gemstone.gemfire.cache.CacheWriter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheWriter</h4> +<pre>public void setCacheWriter(<a href="../../../../com/gemstone/gemfire/cache/CacheWriter.html" title="interface in com.gemstone.gemfire.cache">CacheWriter</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> cacheWriter)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this region has a <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setPoolName-java.lang.String-"><code>pool name set</code></a></dd> +</dl> +</li> +</ul> +<a name="setCacheListener-com.gemstone.gemfire.cache.CacheListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheListener</h4> +<pre>@Deprecated +public void setCacheListener(<a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache">CacheListener</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> aListener)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of GemFire 5.0, use <a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#addCacheListener-com.gemstone.gemfire.cache.CacheListener-"><code>addCacheListener(com.gemstone.gemfire.cache.CacheListener<K, V>)</code></a> instead.</span></div> +<div class="block">Sets the CacheListener for the next <code>RegionAttributes</code> created. + Any existing cache listeners on this factory are removed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aListener</code> - a user defined CacheListener, null if no listener</dd> +</dl> +</li> +</ul> +<a name="addCacheListener-com.gemstone.gemfire.cache.CacheListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCacheListener</h4> +<pre>public void addCacheListener(<a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache">CacheListener</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> aListener)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<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 to the factory.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>aListener</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</dd> +</dl> +</li> +</ul> +<a name="initCacheListeners-com.gemstone.gemfire.cache.CacheListener:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initCacheListeners</h4> +<pre>public void initCacheListeners(<a href="../../../../com/gemstone/gemfire/cache/CacheListener.html" title="interface in com.gemstone.gemfire.cache">CacheListener</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>>[] newListeners)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Removes all cache listeners and then adds each listener in the specified array.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newListeners</code> - a possibly null or empty array of listeners to add to this factory.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if the <code>newListeners</code> array has a null element</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</dd> +</dl> +</li> +</ul> +<a name="setEntryIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEntryIdleTimeout</h4> +<pre>public void setEntryIdleTimeout(<a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> idleTimeout)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the idleTimeout expiration attributes for region entries for the next + <code>RegionAttributes</code> created. + Default is 0 which indicates no expiration of this type.</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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if idleTimeout is null</dd> +</dl> +</li> +</ul> +<a name="setCustomEntryIdleTimeout-com.gemstone.gemfire.cache.CustomExpiry-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCustomEntryIdleTimeout</h4> +<pre>public void setCustomEntryIdleTimeout(<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="interface in com.gemstone.gemfire.cache">CustomExpiry</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> custom)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the idleTimeout CustomExpiry for the next <code>RegionAttributes</code> + created.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>custom</code> - the CustomExpiry to use; null means none will be used.</dd> +</dl> +</li> +</ul> +<a name="setEntryTimeToLive-com.gemstone.gemfire.cache.ExpirationAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEntryTimeToLive</h4> +<pre>public void setEntryTimeToLive(<a href="../../../../com/gemstone/gemfire/cache/ExpirationAttributes.html" title="class in com.gemstone.gemfire.cache">ExpirationAttributes</a> timeToLive)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the timeToLive expiration attributes for region entries for the next + <code>RegionAttributes</code> created. + Default is 0 which indicates no expiration of this type.</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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if timeToLive is null</dd> +</dl> +</li> +</ul> +<a name="setCustomEntryTimeToLive-com.gemstone.gemfire.cache.CustomExpiry-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCustomEntryTimeToLive</h4> +<pre>public void setCustomEntryTimeToLive(<a href="../../../../com/gemstone/gemfire/cache/CustomExpiry.html" title="interface in com.gemstone.gemfire.cache">CustomExpiry</a><<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">K</a>,<a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html" title="type parameter in AttributesFactory">V</a>> custom)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the custom timeToLive for the next <code>RegionAttributes</code> + created.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>custom</code> - the CustomExpiry to use, none if the default for the region + is to be used.</dd> +</dl> +</li> +</ul> +<a name="setRegionIdleTimeout-com.gemstone.gemfire.cache.ExpirationAttributes-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRegionIdleTimeout</h4> +<pre>public void setRegionIdleTimeout(<a href="../../../..
<TRUNCATED>