blob: 33751e75685cb52201f1ade06bf8201acbe35622 [file] [log] [blame]
<!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>DataPolicy (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="DataPolicy (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":41,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":10,"i10":10,"i11":9,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
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><a href="../../../../org/apache/geode/cache/CustomExpiry.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/cache/DataPolicy.html" target="_top">Frames</a></li>
<li><a href="DataPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.geode.cache</div>
<h2 title="Class DataPolicy" class="title">Class DataPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.geode.cache.DataPolicy</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></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public class <span class="typeNameLabel">DataPolicy</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <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></pre>
<div class="block">Enumerated type for region data policy. The data policy specifies how this local cache will
handle the data for a region.
<ol>
<li><code>EMPTY</code> causes data to never be stored in local memory. The region will always
appear empty. It can be used to for zero footprint producers that only want to distribute their
data to others and for zero footprint consumers that only want to see events.
<li><code>NORMAL</code> causes data that this region is interested in to be stored in local
memory. It allows the contents in this cache to differ from other caches.
<li><code>PARTITION</code> causes data that this region holds to be spread across processes. The
amount of data held in this cache is configured in <a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>PartitionAttributes</code></a> with a
<a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html" title="class in org.apache.geode.cache"><code>PartitionAttributesFactory</code></a>.
<li><code>PERSISTENT_PARTITION</code> in addition to <code>PARTITION</code> also causes data to
be stored to disk. The region initialization uses the data stored on disk.
<li><code>REPLICATE</code> causes data that this region is interested in to be stored in local
memory. A distributed region will be initialized with the data from other caches. On distributed
region operations that would cause the contents to differ with other caches are not allowed. This
policy is allowed on local scope region but it behaves the same as <code>NORMAL</code>.
<li><code>PERSISTENT_REPLICATE</code> in addition to <code>REPLICATE</code> also causes data to
be stored to disk. The region initialization uses the data stored on disk. Note that the
persistence applies to both local scope and distributed scope.
</ol></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDataPolicy-org.apache.geode.cache.DataPolicy-"><code>AttributesFactory.setDataPolicy(org.apache.geode.cache.DataPolicy)</code></a>,
<a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDataPolicy--"><code>RegionAttributes.getDataPolicy()</code></a>,
<a href="../../../../serialized-form.html#org.apache.geode.cache.DataPolicy">Serialized Form</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">&nbsp;</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 <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">The data policy used by default; it is <a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#EMPTY">EMPTY</a></span></code>
<div class="block">Data is never stored in local memory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL">NORMAL</a></span></code>
<div class="block">Allows the contents in this cache to differ from other caches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#ordinal">ordinal</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/DataPolicy.html#ordinal--"><code>ordinal()</code></a></span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION">PARTITION</a></span></code>
<div class="block">Data in this region may be spread across a number of processes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_PARTITION">PERSISTENT_PARTITION</a></span></code>
<div class="block">In addition to <code>PARTITION</code> also causes data to be stored to disk.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE">PERSISTENT_REPLICATE</a></span></code>
<div class="block">In addition to <code>REPLICATE</code> also causes data to be stored to disk.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED">PRELOADED</a></span></code>
<div class="block">In addition to <code>NORMAL</code>, contents inside of this cache are (partially) initialized
with data from other caches, if available.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#REPLICATE">REPLICATE</a></span></code>
<div class="block">The region will be initialized with the data from other caches and accepts any new entries
created in other caches.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#fromOrdinal-byte-">fromOrdinal</a></span>(byte&nbsp;ordinal)</code>
<div class="block">Return the DataPolicy represented by specified ordinal</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#fromString-java.lang.String-">fromString</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>&nbsp;s)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/DataPolicy.html#valueOf-java.lang.String-"><code>valueOf(String)</code></a></span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isDefault--">isDefault</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isEmpty--">isEmpty</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use withStorage()</span></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isNormal--">isNormal</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isPartition--">isPartition</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use withPartitioning()</span></div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isPersistentReplicate--">isPersistentReplicate</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use withPersistence() and withReplication()</span></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isPreloaded--">isPreloaded</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use withPreloaded()</span></div>
</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#isReplicate--">isReplicate</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">from version 6.5 forward please use withReplication()</span></div>
</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#ordinal--">ordinal</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string representation for this data policy.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.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>&nbsp;name)</code>
<div class="block">Get enum value by name.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#withPartitioning--">withPartitioning</a></span>()</code>
<div class="block">Return whether this policy does partitioning.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#withPersistence--">withPersistence</a></span>()</code>
<div class="block">Return whether this policy does persistence.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#withPreloaded--">withPreloaded</a></span>()</code>
<div class="block">Return whether this policy does preloaded.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--">withReplication</a></span>()</code>
<div class="block">Return whether this policy does replication.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DataPolicy.html#withStorage--">withStorage</a></span>()</code>
<div class="block">Return true if regions with this policy store data locally.</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="EMPTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EMPTY</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> EMPTY</pre>
<div class="block">Data is never stored in local memory. The region will always be empty locally. It can be used
to for zero footprint producers that only want to distribute their data to others and for zero
footprint consumers that only want to see events.</div>
</li>
</ul>
<a name="NORMAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NORMAL</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> NORMAL</pre>
<div class="block">Allows the contents in this cache to differ from other caches.
<p>
Data that this region is interested in is stored in local memory.</div>
</li>
</ul>
<a name="REPLICATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REPLICATE</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> REPLICATE</pre>
<div class="block">The region will be initialized with the data from other caches and accepts any new entries
created in other caches.
<p>
Operations that would cause the contents to differ with other caches are not allowed.
<p>
Data that this region is interested in is stored in local memory.</div>
</li>
</ul>
<a name="PERSISTENT_REPLICATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERSISTENT_REPLICATE</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> PERSISTENT_REPLICATE</pre>
<div class="block">In addition to <code>REPLICATE</code> also causes data to be stored to disk. The region
initialization may use the data stored on disk.</div>
</li>
</ul>
<a name="PARTITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTITION</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> PARTITION</pre>
<div class="block">Data in this region may be spread across a number of processes. This is further configured with
<a href="../../../../org/apache/geode/cache/PartitionAttributes.html" title="interface in org.apache.geode.cache"><code>partitioning attributes</code></a></div>
</li>
</ul>
<a name="PRELOADED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PRELOADED</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> PRELOADED</pre>
<div class="block">In addition to <code>NORMAL</code>, contents inside of this cache are (partially) initialized
with data from other caches, if available.</div>
</li>
</ul>
<a name="PERSISTENT_PARTITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERSISTENT_PARTITION</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> PERSISTENT_PARTITION</pre>
<div class="block">In addition to <code>PARTITION</code> also causes data to be stored to disk. The region
initialization may use the data stored on disk.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
</dl>
</li>
</ul>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
public static final&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a> DEFAULT</pre>
<div class="block">The data policy used by default; it is <a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</div>
</li>
</ul>
<a name="ordinal">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ordinal</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public final&nbsp;byte ordinal</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/DataPolicy.html#ordinal--"><code>ordinal()</code></a></span></div>
<div class="block">Used as ordinal to represent this DataPolicy</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="ordinal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ordinal</h4>
<pre>public&nbsp;int&nbsp;ordinal()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ordinal value.</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a>&nbsp;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>&nbsp;name)
throws <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></pre>
<div class="block">Get enum value by name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - of enum value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enum by 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 the specified 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 name is null.</dd>
</dl>
</li>
</ul>
<a name="fromOrdinal-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromOrdinal</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a>&nbsp;fromOrdinal(byte&nbsp;ordinal)</pre>
<div class="block">Return the DataPolicy represented by specified ordinal</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - the ordinal representation of a DataPolicy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the DataPolicy represented by specified ordinal</dd>
</dl>
</li>
</ul>
<a name="withStorage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withStorage</h4>
<pre>public&nbsp;boolean&nbsp;withStorage()</pre>
<div class="block">Return true if regions with this policy store data locally.
<p>
Although DataPolicy <a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a> will return true to this query, it is possible to turn
off local storage with <a href="../../../../org/apache/geode/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>PartitionAttributesFactory.setLocalMaxMemory(int)</code></a> by setting
localMaxMemory to zero.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if regions with this policy store data locally.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>PERSISTENT_PARTITION</code></a></dd>
</dl>
</li>
</ul>
<a name="withReplication--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withReplication</h4>
<pre>public&nbsp;boolean&nbsp;withReplication()</pre>
<div class="block">Return whether this policy does replication.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy does replication.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a></dd>
</dl>
</li>
</ul>
<a name="withPersistence--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPersistence</h4>
<pre>public&nbsp;boolean&nbsp;withPersistence()</pre>
<div class="block">Return whether this policy does persistence.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy does persistence.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>PERSISTENT_PARTITION</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a></dd>
</dl>
</li>
</ul>
<a name="withPartitioning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPartitioning</h4>
<pre>public&nbsp;boolean&nbsp;withPartitioning()</pre>
<div class="block">Return whether this policy does partitioning.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy does partitioning</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a>,
<a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_PARTITION"><code>PERSISTENT_PARTITION</code></a></dd>
</dl>
</li>
</ul>
<a name="withPreloaded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPreloaded</h4>
<pre>public&nbsp;boolean&nbsp;withPreloaded()</pre>
<div class="block">Return whether this policy does preloaded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy does preloaded.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 6.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a></dd>
</dl>
</li>
</ul>
<a name="isEmpty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isEmpty()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use withStorage()</span></div>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#EMPTY"><code>EMPTY</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#EMPTY"><code>EMPTY</code></a>.</dd>
</dl>
</li>
</ul>
<a name="isNormal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNormal</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isNormal()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>NORMAL</code></a>.</dd>
</dl>
</li>
</ul>
<a name="isPreloaded--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPreloaded</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isPreloaded()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use withPreloaded()</span></div>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED"><code>PRELOADED</code></a></dd>
</dl>
</li>
</ul>
<a name="isDefault--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDefault</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isDefault()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use an identity comparison instead of this method</span></div>
<div class="block">Return true if this policy is the default.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is the default.</dd>
</dl>
</li>
</ul>
<a name="isReplicate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReplicate</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isReplicate()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use withReplication()</span></div>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#REPLICATE"><code>REPLICATE</code></a>.</dd>
</dl>
</li>
</ul>
<a name="isPersistentReplicate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPersistentReplicate</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isPersistentReplicate()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use withPersistence() and withReplication()</span></div>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#PERSISTENT_REPLICATE"><code>PERSISTENT_REPLICATE</code></a>.</dd>
</dl>
</li>
</ul>
<a name="isPartition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartition</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;boolean&nbsp;isPartition()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">from version 6.5 forward please use withPartitioning()</span></div>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>PARTITION</code></a></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<div class="block">Returns a string representation for this data policy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of this data policy.</dd>
</dl>
</li>
</ul>
<a name="fromString-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fromString</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="../../../../org/apache/geode/cache/DataPolicy.html" title="class in org.apache.geode.cache">DataPolicy</a>&nbsp;fromString(<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>&nbsp;s)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../org/apache/geode/cache/DataPolicy.html#valueOf-java.lang.String-"><code>valueOf(String)</code></a></span></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - a String representation of a DataPolicy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a DataPolicy</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/CustomExpiry.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/Declarable.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/cache/DataPolicy.html" target="_top">Frames</a></li>
<li><a href="DataPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>