blob: 82a01369f15c41a1fa4a97e05c59a34ed42bb38f [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>InterestPolicy (Apache Geode 1.15.1)</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="InterestPolicy (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/IncompatibleVersionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/InterestRegistrationEvent.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/InterestPolicy.html" target="_top">Frames</a></li>
<li><a href="InterestPolicy.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 InterestPolicy" class="title">Class InterestPolicy</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.InterestPolicy</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">InterestPolicy</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 subscription interest policy. The interest policy specifies what data
a subscriber is interested in having in it's region.</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/SubscriptionAttributes.html" title="class in org.apache.geode.cache"><code>SubscriptionAttributes</code></a>,
<a href="../../../../serialized-form.html#org.apache.geode.cache.InterestPolicy">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/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/InterestPolicy.html#ALL">ALL</a></span></code>
<div class="block">This subscriber is interested in all data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/InterestPolicy.html#CACHE_CONTENT">CACHE_CONTENT</a></span></code>
<div class="block">This subscriber is interested in data that is already in its cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/cache/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/InterestPolicy.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">The interest policy used by default; it is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</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/InterestPolicy.html#ordinal">ordinal</a></span></code>
<div class="block">used as ordinal to represent this InterestPolicy</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></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/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/InterestPolicy.html#fromOrdinal-byte-">fromOrdinal</a></span>(byte&nbsp;ordinal)</code>
<div class="block">Return the InterestPolicy represented by specified ordinal</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/InterestPolicy.html#isAll--">isAll</a></span>()</code>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#ALL"><code>ALL</code></a>.</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/InterestPolicy.html#isCacheContent--">isCacheContent</a></span>()</code>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</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/InterestPolicy.html#isDefault--">isDefault</a></span>()</code>
<div class="block">Return true if this policy is the default.</div>
</td>
</tr>
<tr id="i4" 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/InterestPolicy.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string representation for this interest policy.</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="ALL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ALL</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/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a> ALL</pre>
<div class="block">This subscriber is interested in all data. More specifically operations done in this cache and
distributed operations done in remote caches.
<p>
When combined with <a href="../../../../org/apache/geode/cache/DataPolicy.html#EMPTY"><code>DataPolicy.EMPTY</code></a> this region will receive events for every
distributed operation but will not store the data.
<p>
When combined with <a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a> or <a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED"><code>DataPolicy.PRELOADED</code></a> this region will
accept <a href="../../../../org/apache/geode/cache/Region.html#create-K-V-"><code>Region.create(Object, Object)</code></a> operations done remotely. Without the
<code>ALL</code> interest policy, <code>NORMAL</code> and <code>PRELOADED</code> ignore
<code>creates</code> that the region does not have an existing entry for.
<p>
When combined with the <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replication policies</code></a> this interest
has no effect.
<p>
When combined with <a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a> this interest policy causes cache listeners to
be notified of changes regardless of the physical location of the data affected. That is, a
listener in a VM using this policy will receive notification of all changes to the partitioned
region.</div>
</li>
</ul>
<a name="CACHE_CONTENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CACHE_CONTENT</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/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a> CACHE_CONTENT</pre>
<div class="block">This subscriber is interested in data that is already in its cache. More specifically
operations done in this cache and distributed operations done in remote caches.
<p>
When combined with <a href="../../../../org/apache/geode/cache/DataPolicy.html#EMPTY"><code>DataPolicy.EMPTY</code></a> this region will never receive events for
distributed operations since its content is always empty. It will continue to get events for
operations done locally.
<p>
When combined with <a href="../../../../org/apache/geode/cache/DataPolicy.html#NORMAL"><code>DataPolicy.NORMAL</code></a> or <a href="../../../../org/apache/geode/cache/DataPolicy.html#PRELOADED"><code>DataPolicy.PRELOADED</code></a> this region will
accept remote operations done to entries it already has in its cache.
<p>
When combined with the <a href="../../../../org/apache/geode/cache/DataPolicy.html#withReplication--"><code>replication policies</code></a> * this interest
has no effect.
<p>
When combined with <a href="../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a> this interest policy causes cache listeners to
be notified in the VM holding the affected data. That is, listeners are only notified if the
affected* key-value pair is in the same process as the listener.</div>
</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/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a> DEFAULT</pre>
<div class="block">The interest policy used by default; it is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</div>
</li>
</ul>
<a name="ordinal">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ordinal</h4>
<pre>public final&nbsp;byte ordinal</pre>
<div class="block">used as ordinal to represent this InterestPolicy</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromOrdinal-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromOrdinal</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/geode/cache/InterestPolicy.html" title="class in org.apache.geode.cache">InterestPolicy</a>&nbsp;fromOrdinal(byte&nbsp;ordinal)</pre>
<div class="block">Return the InterestPolicy represented by specified ordinal</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - the ordinal representation of an InterestPolicy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the InterestPolicy represented by specified ordinal</dd>
</dl>
</li>
</ul>
<a name="isAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAll</h4>
<pre>public&nbsp;boolean&nbsp;isAll()</pre>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#ALL"><code>ALL</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#ALL"><code>ALL</code></a>.</dd>
</dl>
</li>
</ul>
<a name="isCacheContent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCacheContent</h4>
<pre>public&nbsp;boolean&nbsp;isCacheContent()</pre>
<div class="block">Return true if this policy is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this policy is <a href="../../../../org/apache/geode/cache/InterestPolicy.html#CACHE_CONTENT"><code>CACHE_CONTENT</code></a>.</dd>
</dl>
</li>
</ul>
<a name="isDefault--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDefault</h4>
<pre>public&nbsp;boolean&nbsp;isDefault()</pre>
<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="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<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 interest 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 interest policy.</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/IncompatibleVersionException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/cache/InterestRegistrationEvent.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/InterestPolicy.html" target="_top">Frames</a></li>
<li><a href="InterestPolicy.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>