| <!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>ClientRegionShortcut (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="ClientRegionShortcut (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/geode/cache/client/ClientRegionFactory.html" title="interface in org.apache.geode.cache.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/client/NoAvailableLocatorsException.html" title="class in org.apache.geode.cache.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/client/ClientRegionShortcut.html" target="_top">Frames</a></li> |
| <li><a href="ClientRegionShortcut.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="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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.client</div> |
| <h2 title="Enum ClientRegionShortcut" class="title">Enum ClientRegionShortcut</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.cache.client.ClientRegionShortcut</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public enum <span class="typeNameLabel">ClientRegionShortcut</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a>></pre> |
| <div class="block">Each enum represents a predefined <a href="../../../../../org/apache/geode/cache/RegionAttributes.html" title="interface in org.apache.geode.cache"><code>RegionAttributes</code></a> in a <a href="../../../../../org/apache/geode/cache/client/ClientCache.html" title="interface in org.apache.geode.cache.client"><code>ClientCache</code></a>. These enum |
| values can be used to create regions using a <a href="../../../../../org/apache/geode/cache/client/ClientRegionFactory.html" title="interface in org.apache.geode.cache.client"><code>ClientRegionFactory</code></a> obtained by calling |
| <a href="../../../../../org/apache/geode/cache/client/ClientCache.html#createClientRegionFactory-org.apache.geode.cache.client.ClientRegionShortcut-"><code>ClientCache.createClientRegionFactory(ClientRegionShortcut)</code></a>. |
| <p> |
| Another way to use predefined region attributes is in cache.xml by setting the refid attribute on |
| a region element or region-attributes element to the string of each value.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#CACHING_PROXY">CACHING_PROXY</a></span></code> |
| <div class="block">A CACHING_PROXY region has local state but can also send operations to a server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#CACHING_PROXY_HEAP_LRU">CACHING_PROXY_HEAP_LRU</a></span></code> |
| <div class="block">A CACHING_PROXY_HEAP_LRU region has local state but can also send operations to a server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#CACHING_PROXY_OVERFLOW">CACHING_PROXY_OVERFLOW</a></span></code> |
| <div class="block">A CACHING_PROXY_OVERFLOW region has local state but can also send operations to a server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#LOCAL">LOCAL</a></span></code> |
| <div class="block">A LOCAL region only has local state and never sends operations to a server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#LOCAL_HEAP_LRU">LOCAL_HEAP_LRU</a></span></code> |
| <div class="block">A LOCAL_HEAP_LRU region only has local state and never sends operations to a server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#LOCAL_OVERFLOW">LOCAL_OVERFLOW</a></span></code> |
| <div class="block">A LOCAL_OVERFLOW region only has local state and never sends operations to a server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#LOCAL_PERSISTENT">LOCAL_PERSISTENT</a></span></code> |
| <div class="block">A LOCAL_PERSISTENT region only has local state and never sends operations to a server but it |
| does write its state to disk and can recover that state when the region is created.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#LOCAL_PERSISTENT_OVERFLOW">LOCAL_PERSISTENT_OVERFLOW</a></span></code> |
| <div class="block">A LOCAL_PERSISTENT_OVERFLOW region only has local state and never sends operations to a server |
| but it does write its state to disk and can recover that state when the region is created.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#PROXY">PROXY</a></span></code> |
| <div class="block">A PROXY region has no local state and forwards all operations to a server.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#valueOf-java.lang.String-">valueOf</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">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> |
| </ul> |
| <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#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#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#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"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="PROXY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PROXY</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> PROXY</pre> |
| <div class="block">A PROXY region has no local state and forwards all operations to a server. The actual |
| RegionAttributes for a PROXY set the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to <a href="../../../../../org/apache/geode/cache/DataPolicy.html#EMPTY"><code>DataPolicy.EMPTY</code></a>.</div> |
| </li> |
| </ul> |
| <a name="CACHING_PROXY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_PROXY</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> CACHING_PROXY</pre> |
| <div class="block">A CACHING_PROXY region has local state but can also send operations to a server. If the local |
| state is not found then the operation is sent to the server and the local state is updated to |
| contain the server result. The actual RegionAttributes for a CACHING_PROXY set the |
| <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to <a href="../../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a>.</div> |
| </li> |
| </ul> |
| <a name="CACHING_PROXY_HEAP_LRU"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_PROXY_HEAP_LRU</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> CACHING_PROXY_HEAP_LRU</pre> |
| <div class="block">A CACHING_PROXY_HEAP_LRU region has local state but can also send operations to a server. If |
| the local state is not found then the operation is sent to the server and the local state is |
| updated to contain the server result. It will also destroy entries once it detects that the |
| java vm is running low of memory. The actual RegionAttributes for a CACHING_PROXY_HEAP_LRU set |
| the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to <a href="../../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a>. and <a href="../../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache"><code>EvictionAttributes</code></a> are set to |
| <a href="../../../../../org/apache/geode/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a> with <a href="../../../../../org/apache/geode/cache/EvictionAction.html#LOCAL_DESTROY"><code>EvictionAction.LOCAL_DESTROY</code></a>.</div> |
| </li> |
| </ul> |
| <a name="CACHING_PROXY_OVERFLOW"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CACHING_PROXY_OVERFLOW</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> CACHING_PROXY_OVERFLOW</pre> |
| <div class="block">A CACHING_PROXY_OVERFLOW region has local state but can also send operations to a server. If |
| the local state is not found then the operation is sent to the server and the local state is |
| updated to contain the server result. It will also move the values of entries to disk once it |
| detects that the java vm is running low of memory. The actual RegionAttributes for a |
| CACHING_PROXY_OVERFLOW set the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to <a href="../../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a>. and |
| <a href="../../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache"><code>EvictionAttributes</code></a> are set to <a href="../../../../../org/apache/geode/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a> with |
| <a href="../../../../../org/apache/geode/cache/EvictionAction.html#OVERFLOW_TO_DISK"><code>EvictionAction.OVERFLOW_TO_DISK</code></a>.</div> |
| </li> |
| </ul> |
| <a name="LOCAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> LOCAL</pre> |
| <div class="block">A LOCAL region only has local state and never sends operations to a server. The actual |
| RegionAttributes for a LOCAL region set the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to <a href="../../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a>.</div> |
| </li> |
| </ul> |
| <a name="LOCAL_PERSISTENT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL_PERSISTENT</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> LOCAL_PERSISTENT</pre> |
| <div class="block">A LOCAL_PERSISTENT region only has local state and never sends operations to a server but it |
| does write its state to disk and can recover that state when the region is created. The actual |
| RegionAttributes for a LOCAL_PERSISTENT region set the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to |
| <a href="../../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>DataPolicy.PERSISTENT_REPLICATE</code></a>.</div> |
| </li> |
| </ul> |
| <a name="LOCAL_HEAP_LRU"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL_HEAP_LRU</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> LOCAL_HEAP_LRU</pre> |
| <div class="block">A LOCAL_HEAP_LRU region only has local state and never sends operations to a server. It will |
| also destroy entries once it detects that the java vm is running low of memory. The actual |
| RegionAttributes for a LOCAL_HEAP_LRU region set the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to |
| <a href="../../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a> and <a href="../../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache"><code>EvictionAttributes</code></a> are set to |
| <a href="../../../../../org/apache/geode/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a> with <a href="../../../../../org/apache/geode/cache/EvictionAction.html#LOCAL_DESTROY"><code>EvictionAction.LOCAL_DESTROY</code></a>.</div> |
| </li> |
| </ul> |
| <a name="LOCAL_OVERFLOW"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL_OVERFLOW</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> LOCAL_OVERFLOW</pre> |
| <div class="block">A LOCAL_OVERFLOW region only has local state and never sends operations to a server. It will |
| also move the values of entries to disk once it detects that the java vm is running low of |
| memory. The actual RegionAttributes for a LOCAL_OVERFLOW region set the <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to |
| <a href="../../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a> and <a href="../../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache"><code>EvictionAttributes</code></a> are set to |
| <a href="../../../../../org/apache/geode/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a> with <a href="../../../../../org/apache/geode/cache/EvictionAction.html#OVERFLOW_TO_DISK"><code>EvictionAction.OVERFLOW_TO_DISK</code></a>.</div> |
| </li> |
| </ul> |
| <a name="LOCAL_PERSISTENT_OVERFLOW"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LOCAL_PERSISTENT_OVERFLOW</h4> |
| <pre>public static final <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> LOCAL_PERSISTENT_OVERFLOW</pre> |
| <div class="block">A LOCAL_PERSISTENT_OVERFLOW region only has local state and never sends operations to a server |
| but it does write its state to disk and can recover that state when the region is created. It |
| will also remove the values of entries from memory once it detects that the java vm is running |
| low of memory. The actual RegionAttributes for a LOCAL_PERSISTENT_OVERFLOW region set the |
| <a href="../../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache"><code>DataPolicy</code></a> to <a href="../../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>DataPolicy.PERSISTENT_REPLICATE</code></a> and <a href="../../../../../org/apache/geode/cache/EvictionAttributes.html" title="class in org.apache.geode.cache"><code>EvictionAttributes</code></a> |
| are set to <a href="../../../../../org/apache/geode/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a> with <a href="../../../../../org/apache/geode/cache/EvictionAction.html#OVERFLOW_TO_DISK"><code>EvictionAction.OVERFLOW_TO_DISK</code></a>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (ClientRegionShortcut c : ClientRegionShortcut.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../../../org/apache/geode/cache/client/ClientRegionShortcut.html" title="enum in org.apache.geode.cache.client">ClientRegionShortcut</a> valueOf(<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">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</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 this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</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/client/ClientRegionFactory.html" title="interface in org.apache.geode.cache.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/client/NoAvailableLocatorsException.html" title="class in org.apache.geode.cache.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/client/ClientRegionShortcut.html" target="_top">Frames</a></li> |
| <li><a href="ClientRegionShortcut.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
