api/3.0/org/eclipse/persistence/queries/QueryResultsCachePolicy.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:08 UTC 2021 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>QueryResultsCachePolicy (EclipseLink 3.0.2, API Reference)</title>
 <meta name="date" content="2021-07-16">
 <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="QueryResultsCachePolicy (EclipseLink 3.0.2, API Reference)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
 var tabs = {65535:["t0","All 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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/eclipse/persistence/queries/QueryRedirectorHelper.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/queries/QueryResultsCachePolicy.html" target="_top">Frames</a></li>
 <li><a href="QueryResultsCachePolicy.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.eclipse.persistence.queries</div>
 <h2 title="Class QueryResultsCachePolicy" class="title">Class QueryResultsCachePolicy</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.eclipse.persistence.queries.QueryResultsCachePolicy</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/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">QueryResultsCachePolicy</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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre>
 <div class="block">PUBLIC:

  A QueryResultsCache policy dictates how a query's results will be cached.

  It allows an invalidation policy and a maximum number of results to be set.
  Query results are cached based on the parameter values of a query, and the maximum number
  of results refers to the maximum number of parameter sets results will be cached for.\
  By default query result caching is not used.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryResultsCachePolicy-org.eclipse.persistence.queries.QueryResultsCachePolicy-"><code>ReadQuery.setQueryResultsCachePolicy(QueryResultsCachePolicy)</code></a>,
 <a href="../../../../serialized-form.html#org.eclipse.persistence.queries.QueryResultsCachePolicy">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>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#cacheType">cacheType</a></span></code>
 <div class="block">Allows the identity map class type to be set.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#invalidateOnChange">invalidateOnChange</a></span></code>
 <div class="block">Allows the query cache to be invalidated when any object of any of the query classes is modified.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#invalidationClasses">invalidationClasses</a></span></code>
 <div class="block">Stores the set of classes that should trigger the query cached results to be invalidated.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#invalidationPolicy">invalidationPolicy</a></span></code>
 <div class="block">Allows invalidation to be specified.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#isNullIgnored">isNullIgnored</a></span></code>
 <div class="block">Allows the caching of null to be configured.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#maximumResultSets">maximumResultSets</a></span></code>
 <div class="block">Specifies the cache size.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#QueryResultsCachePolicy--">QueryResultsCachePolicy</a></span>()</code>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy with the default settings
  By default there is no invalidation of query results and the maximum
  number of results sets is 100.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#QueryResultsCachePolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-">QueryResultsCachePolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;policy)</code>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy and supply a CacheInvalidationPolicy.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#QueryResultsCachePolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-int-">QueryResultsCachePolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;policy,
                        int&nbsp;maximumResultSets)</code>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy and supply a CacheInvalidationPolicy and a maximum
  number of results sets.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#QueryResultsCachePolicy-int-">QueryResultsCachePolicy</a></span>(int&nbsp;maximumResultSets)</code>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy and supply a maximum for the number of results sets.</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="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><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#clone--">clone</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#getCacheInvalidationPolicy--">getCacheInvalidationPolicy</a></span>()</code>
 <div class="block">PUBLIC:
  Return the query cache invalidation policy.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#getCacheType--">getCacheType</a></span>()</code>
 <div class="block">PUBLIC:
  Return the type of the cache used for the query results.</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/eclipse/persistence/queries/QueryResultsCachePolicy.html#getInvalidateOnChange--">getInvalidateOnChange</a></span>()</code>
 <div class="block">PUBLIC:
  Return if any change to any object of the query class should cause the query results to be invalidated.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#getInvalidationClasses--">getInvalidationClasses</a></span>()</code>
 <div class="block">ADVANCED:
  Return the set of classes that should trigger the query cached results to be invalidated.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#getMaximumCachedResults--">getMaximumCachedResults</a></span>()</code>
 <div class="block">PUBLIC:
  Return the maximum cached results.</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/eclipse/persistence/queries/QueryResultsCachePolicy.html#isNullIgnored--">isNullIgnored</a></span>()</code>
 <div class="block">PUBLIC:
  Return if null results should be cached or ignored.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setCacheInvalidationPolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-">setCacheInvalidationPolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;invalidationPolicy)</code>
 <div class="block">PUBLIC:
  Set the query cache invalidation policy.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setCacheType-java.lang.Class-">setCacheType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cacheType)</code>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setInvalidateOnChange-boolean-">setInvalidateOnChange</a></span>(boolean&nbsp;invalidateOnChange)</code>
 <div class="block">PUBLIC:
  Configure if any change to any object of the query class should cause the query results to be invalidated.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setInvalidationClasses-java.util.Set-">setInvalidationClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&gt;&nbsp;invalidationClasses)</code>
 <div class="block">ADVANCED:
  Set the set of classes that should trigger the query cached results to be invalidated.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setIsNullIgnored-boolean-">setIsNullIgnored</a></span>(boolean&nbsp;isNullIgnored)</code>
 <div class="block">PUBLIC:
  Set if null results should be cached or ignored.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#setMaximumCachedResults-int-">setMaximumCachedResults</a></span>(int&nbsp;maximumResultSets)</code>
 <div class="block">PUBLIC:
  Set the maximum cached results.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#useFullCache--">useFullCache</a></span>()</code>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a FullIdentityMap.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#useLRUCache--">useLRUCache</a></span>()</code>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a CacheIdentityMap.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#useSoftCache--">useSoftCache</a></span>()</code>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a SoftIdentityMap.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html#useSoftLRUCache--">useSoftLRUCache</a></span>()</code>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a SoftCacheWeakIdentityMap.</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#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="invalidationPolicy">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>invalidationPolicy</h4>
 <pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a> invalidationPolicy</pre>
 <div class="block">Allows invalidation to be specified.</div>
 </li>
 </ul>
 <a name="maximumResultSets">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maximumResultSets</h4>
 <pre>protected&nbsp;int maximumResultSets</pre>
 <div class="block">Specifies the cache size.</div>
 </li>
 </ul>
 <a name="cacheType">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cacheType</h4>
 <pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cacheType</pre>
 <div class="block">Allows the identity map class type to be set.</div>
 </li>
 </ul>
 <a name="isNullIgnored">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isNullIgnored</h4>
 <pre>protected&nbsp;boolean isNullIgnored</pre>
 <div class="block">Allows the caching of null to be configured.</div>
 </li>
 </ul>
 <a name="invalidateOnChange">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>invalidateOnChange</h4>
 <pre>protected&nbsp;boolean invalidateOnChange</pre>
 <div class="block">Allows the query cache to be invalidated when any object of any of the query classes is modified.</div>
 </li>
 </ul>
 <a name="invalidationClasses">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>invalidationClasses</h4>
 <pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&gt; invalidationClasses</pre>
 <div class="block">Stores the set of classes that should trigger the query cached results to be invalidated.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="QueryResultsCachePolicy--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>QueryResultsCachePolicy</h4>
 <pre>public&nbsp;QueryResultsCachePolicy()</pre>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy with the default settings
  By default there is no invalidation of query results and the maximum
  number of results sets is 100.</div>
 </li>
 </ul>
 <a name="QueryResultsCachePolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>QueryResultsCachePolicy</h4>
 <pre>public&nbsp;QueryResultsCachePolicy(<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;policy,
                                int&nbsp;maximumResultSets)</pre>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy and supply a CacheInvalidationPolicy and a maximum
  number of results sets.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation"><code>CacheInvalidationPolicy</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="QueryResultsCachePolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>QueryResultsCachePolicy</h4>
 <pre>public&nbsp;QueryResultsCachePolicy(<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;policy)</pre>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy and supply a CacheInvalidationPolicy. The default
  value of 100 will be used for the maximum number of result sets</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation"><code>CacheInvalidationPolicy</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="QueryResultsCachePolicy-int-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>QueryResultsCachePolicy</h4>
 <pre>public&nbsp;QueryResultsCachePolicy(int&nbsp;maximumResultSets)</pre>
 <div class="block">PUBLIC:
  Build a QueryResultsCachePolicy and supply a maximum for the number of results sets.
  Results will be set not to expire in the cache.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="clone--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clone</h4>
 <pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a>&nbsp;clone()</pre>
 <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#clone--" title="class or interface in java.lang">clone</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>
 </dl>
 </li>
 </ul>
 <a name="getInvalidationClasses--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInvalidationClasses</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&gt;&nbsp;getInvalidationClasses()</pre>
 <div class="block">ADVANCED:
  Return the set of classes that should trigger the query cached results to be invalidated.</div>
 </li>
 </ul>
 <a name="setInvalidationClasses-java.util.Set-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setInvalidationClasses</h4>
 <pre>public&nbsp;void&nbsp;setInvalidationClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&gt;&nbsp;invalidationClasses)</pre>
 <div class="block">ADVANCED:
  Set the set of classes that should trigger the query cached results to be invalidated.
  This is normally computed by the query, but can be set in the case of native queries.</div>
 </li>
 </ul>
 <a name="isNullIgnored--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isNullIgnored</h4>
 <pre>public&nbsp;boolean&nbsp;isNullIgnored()</pre>
 <div class="block">PUBLIC:
  Return if null results should be cached or ignored.
  By default they are cached.
  They can be ignored to allow a query cache to be used as a secondary cache index,
  and allow new objects to be insert, and still found.</div>
 </li>
 </ul>
 <a name="setIsNullIgnored-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setIsNullIgnored</h4>
 <pre>public&nbsp;void&nbsp;setIsNullIgnored(boolean&nbsp;isNullIgnored)</pre>
 <div class="block">PUBLIC:
  Set if null results should be cached or ignored.
  By default they are cached.
  They can be ignored to allow a query cache to be used as a secondary cache index,
  and allow new objects to be insert, and still found.</div>
 </li>
 </ul>
 <a name="getInvalidateOnChange--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInvalidateOnChange</h4>
 <pre>public&nbsp;boolean&nbsp;getInvalidateOnChange()</pre>
 <div class="block">PUBLIC:
  Return if any change to any object of the query class should cause the query results to be invalidated.</div>
 </li>
 </ul>
 <a name="setInvalidateOnChange-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setInvalidateOnChange</h4>
 <pre>public&nbsp;void&nbsp;setInvalidateOnChange(boolean&nbsp;invalidateOnChange)</pre>
 <div class="block">PUBLIC:
  Configure if any change to any object of the query class should cause the query results to be invalidated.</div>
 </li>
 </ul>
 <a name="getCacheType--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCacheType</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getCacheType()</pre>
 <div class="block">PUBLIC:
  Return the type of the cache used for the query results.
  This defaults to a LRU cache (CacheIdentityMap), but can be
  set to any IdentityMap class, such as Full or Soft.</div>
 </li>
 </ul>
 <a name="setCacheType-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setCacheType</h4>
 <pre>public&nbsp;void&nbsp;setCacheType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cacheType)</pre>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results.
  This defaults to a LRU cache (CacheIdentityMap), but can be
  set to any IdentityMap class, such as Full or Soft.</div>
 </li>
 </ul>
 <a name="useFullCache--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>useFullCache</h4>
 <pre>public&nbsp;void&nbsp;useFullCache()</pre>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a FullIdentityMap.
  This will cache all query results, so caution should be used to avoid running out of memory.</div>
 </li>
 </ul>
 <a name="useSoftCache--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>useSoftCache</h4>
 <pre>public&nbsp;void&nbsp;useSoftCache()</pre>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a SoftIdentityMap.
  This will cache all query results, unless the JVM believes memory is low.</div>
 </li>
 </ul>
 <a name="useSoftLRUCache--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>useSoftLRUCache</h4>
 <pre>public&nbsp;void&nbsp;useSoftLRUCache()</pre>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a SoftCacheWeakIdentityMap.
  This will uses a fixed size LRU cache using Soft references, so will allow garbage collection when memory is low.</div>
 </li>
 </ul>
 <a name="useLRUCache--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>useLRUCache</h4>
 <pre>public&nbsp;void&nbsp;useLRUCache()</pre>
 <div class="block">PUBLIC:
  Set the type of the cache used for the query results to a CacheIdentityMap.
  This will uses a fixed size LRU cache.
  This is the default.</div>
 </li>
 </ul>
 <a name="getCacheInvalidationPolicy--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCacheInvalidationPolicy</h4>
 <pre>public&nbsp;<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;getCacheInvalidationPolicy()</pre>
 <div class="block">PUBLIC:
  Return the query cache invalidation policy.
  The cache invalidation policy defines how the query results are invalidated.</div>
 </li>
 </ul>
 <a name="setCacheInvalidationPolicy-org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setCacheInvalidationPolicy</h4>
 <pre>public&nbsp;void&nbsp;setCacheInvalidationPolicy(<a href="../../../../org/eclipse/persistence/descriptors/invalidation/CacheInvalidationPolicy.html" title="class in org.eclipse.persistence.descriptors.invalidation">CacheInvalidationPolicy</a>&nbsp;invalidationPolicy)</pre>
 <div class="block">PUBLIC:
  Set the query cache invalidation policy.
  The cache invalidation policy defines how the query results are invalidated.</div>
 </li>
 </ul>
 <a name="getMaximumCachedResults--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMaximumCachedResults</h4>
 <pre>public&nbsp;int&nbsp;getMaximumCachedResults()</pre>
 <div class="block">PUBLIC:
  Return the maximum cached results.
  This defines the number of query result sets that will be cached.
  The LRU query results will be discarded when the max size is reached.</div>
 </li>
 </ul>
 <a name="setMaximumCachedResults-int-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>setMaximumCachedResults</h4>
 <pre>public&nbsp;void&nbsp;setMaximumCachedResults(int&nbsp;maximumResultSets)</pre>
 <div class="block">PUBLIC:
  Set the maximum cached results.
  This defines the number of query result sets that will be cached.
  The LRU query results will be discarded when the max size is reached.</div>
 </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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/eclipse/persistence/queries/QueryRedirectorHelper.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/queries/ReadAllQuery.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/queries/QueryResultsCachePolicy.html" target="_top">Frames</a></li>
 <li><a href="QueryResultsCachePolicy.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
 </body>
 </html>