api/3.0/org/eclipse/persistence/jpa/JpaCache.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:09 UTC 2021 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>JpaCache (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="JpaCache (EclipseLink 3.0.2, API Reference)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/jpa/ArchiveFactory.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/jpa/JpaCriteriaBuilder.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/jpa/JpaCache.html" target="_top">Frames</a></li>
 <li><a href="JpaCache.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>Field&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>Field&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.eclipse.persistence.jpa</div>
 <h2 title="Interface JpaCache" class="title">Interface JpaCache</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd>jakarta.persistence.Cache</dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">JpaCache</span>
 extends jakarta.persistence.Cache</pre>
 <div class="block">Extends JPA Cache interface with additional EclipseLink API.</div>
 <dl>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>James Sutherland</dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#clear--">clear</a></span>()</code>
 <div class="block">ADVANCED:
  Resets the entire Object cache, and the Query cache.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#clear-java.lang.Class-">clear</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;cls)</code>
 <div class="block">ADVANCED:
  Resets the cache for only the instances of the given Class type.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#clearQueryCache--">clearQueryCache</a></span>()</code>
 <div class="block">Clear all the query results caches.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#clearQueryCache-java.lang.Class-">clearQueryCache</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;entityClass)</code>
 <div class="block">Clear all named query results cache associated with entity class.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#clearQueryCache-java.lang.String-">clearQueryCache</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;queryName)</code>
 <div class="block">Clear the named query results cache associated with the query name.</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/eclipse/persistence/jpa/JpaCache.html#contains-java.lang.Object-">contains</a></span>(<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>&nbsp;object)</code>
 <div class="block">Returns true if the cache contains an Object with the same id and Class type of the given object.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#evict-java.lang.Class-java.lang.Object-boolean-">evict</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;classToEvict,
      <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>&nbsp;id,
      boolean&nbsp;invalidateInCluster)</code>
 <div class="block">Sets the object of the class and id to be invalid in the cache.</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/jpa/JpaCache.html#evict-java.lang.Object-">evict</a></span>(<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>&nbsp;object)</code>
 <div class="block">Sets an Object to be invalid in the cache.</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/jpa/JpaCache.html#evict-java.lang.Object-boolean-">evict</a></span>(<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>&nbsp;object,
      boolean&nbsp;invalidateInCluster)</code>
 <div class="block">Sets an Object to be invalid in the cache.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><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></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#getId-java.lang.Object-">getId</a></span>(<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>&nbsp;object)</code>
 <div class="block">Returns the object's Id.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><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></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#getObject-java.lang.Class-java.lang.Object-">getObject</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;cls,
          <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>&nbsp;id)</code>
 <div class="block">Returns the Object from the cache map with the id
  and Class type.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#isValid-java.lang.Class-java.lang.Object-">isValid</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;cls,
        <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>&nbsp;id)</code>
 <div class="block">Returns true if the Object with the id and Class type is valid in the cache.</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/eclipse/persistence/jpa/JpaCache.html#isValid-java.lang.Object-">isValid</a></span>(<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>&nbsp;object)</code>
 <div class="block">Returns true if the Object with the same id and Class type of the
  the given Object is valid in the cache.</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/jpa/JpaCache.html#print--">print</a></span>()</code>
 <div class="block">Used to print all the Objects in the cache.</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/jpa/JpaCache.html#print-java.lang.Class-">print</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;cls)</code>
 <div class="block">Used to print all the Objects in the cache of the Class type.</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/jpa/JpaCache.html#printLocks--">printLocks</a></span>()</code>
 <div class="block">Used to print all the currently locked cache keys in the cache.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><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></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#putObject-java.lang.Object-">putObject</a></span>(<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>&nbsp;object)</code>
 <div class="block">ADVANCED:
  Puts the given Object into the cache.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><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></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#removeObject-java.lang.Class-java.lang.Object-">removeObject</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;cls,
             <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>&nbsp;id)</code>
 <div class="block">ADVANCED:
  Removes the Object with the id and Class type from the cache.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><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></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#removeObject-java.lang.Object-">removeObject</a></span>(<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>&nbsp;object)</code>
 <div class="block">ADVANCED:
  Removes the Object from the cache.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#timeToLive-java.lang.Object-">timeToLive</a></span>(<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>&nbsp;object)</code>
 <div class="block">Returns the remaining life of the given Object (in milliseconds).</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/jpa/JpaCache.html#validate--">validate</a></span>()</code>
 <div class="block">This can be used to help debugging an Object identity problem.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.Cache">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;jakarta.persistence.Cache</h3>
 <code>contains, evict, evict, evictAll, unwrap</code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="clear--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clear</h4>
 <pre>void&nbsp;clear()</pre>
 <div class="block">ADVANCED:
  Resets the entire Object cache, and the Query cache.
  <p> NOTE: Be careful using this method. This method blows away both this session's and its parent's caches.
  This includes the server cache or any other cache. This throws away any Objects that have been read in.
  Extreme caution should be used before doing this because Object identity will no longer
  be maintained for any Objects currently read in.  This should only be called
  if the application knows that it no longer has references to Objects held in the cache.</div>
 </li>
 </ul>
 <a name="clear-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clear</h4>
 <pre>void&nbsp;clear(<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;cls)</pre>
 <div class="block">ADVANCED:
  Resets the cache for only the instances of the given Class type.
  For inheritance the user must make sure that they only use the root class,
  clearing a subclass cache is not allowed (as they share their parents cache).
  <p> NOTE: Caution must be used in doing this to ensure that the Objects within the cache
  are not referenced from other Objects of other classes or from the application.</div>
 </li>
 </ul>
 <a name="clearQueryCache--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clearQueryCache</h4>
 <pre>void&nbsp;clearQueryCache()</pre>
 <div class="block">Clear all the query results caches.</div>
 </li>
 </ul>
 <a name="clearQueryCache-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clearQueryCache</h4>
 <pre>void&nbsp;clearQueryCache(<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;queryName)</pre>
 <div class="block">Clear the named query results cache associated with the query name.</div>
 </li>
 </ul>
 <a name="clearQueryCache-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clearQueryCache</h4>
 <pre>void&nbsp;clearQueryCache(<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;entityClass)</pre>
 <div class="block">Clear all named query results cache associated with entity class.</div>
 </li>
 </ul>
 <a name="timeToLive-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>timeToLive</h4>
 <pre>long&nbsp;timeToLive(<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>&nbsp;object)</pre>
 <div class="block">Returns the remaining life of the given Object (in milliseconds).  This method is associated with use of
  cache invalidation feature and returns the difference between the next expiry
  time of the Object and its read time.  The method will return 0 for invalidated Objects.</div>
 </li>
 </ul>
 <a name="isValid-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isValid</h4>
 <pre>boolean&nbsp;isValid(<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>&nbsp;object)</pre>
 <div class="block">Returns true if the Object with the same id and Class type of the
  the given Object is valid in the cache.</div>
 </li>
 </ul>
 <a name="isValid-java.lang.Class-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isValid</h4>
 <pre>boolean&nbsp;isValid(<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;cls,
                 <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>&nbsp;id)</pre>
 <div class="block">Returns true if the Object with the id and Class type is valid in the cache.</div>
 </li>
 </ul>
 <a name="print--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>print</h4>
 <pre>void&nbsp;print()</pre>
 <div class="block">Used to print all the Objects in the cache.
  The output of this method will be logged to this persistence unit's SessionLog at SEVERE level.</div>
 </li>
 </ul>
 <a name="print-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>print</h4>
 <pre>void&nbsp;print(<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;cls)</pre>
 <div class="block">Used to print all the Objects in the cache of the Class type.
  The output of this method will be logged to this persistence unit's SessionLog at SEVERE level.</div>
 </li>
 </ul>
 <a name="printLocks--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>printLocks</h4>
 <pre>void&nbsp;printLocks()</pre>
 <div class="block">Used to print all the currently locked cache keys in the cache.
  The output of this method will be logged to this persistence unit's SessionLog at SEVERE level.</div>
 </li>
 </ul>
 <a name="validate--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>validate</h4>
 <pre>void&nbsp;validate()</pre>
 <div class="block">This can be used to help debugging an Object identity problem.
  An Object identity problem is when an Object in the cache references an
  Object that is not in the cache. This method will validate that all cached
  Objects are in a correct state.</div>
 </li>
 </ul>
 <a name="getObject-java.lang.Class-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getObject</h4>
 <pre><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>&nbsp;getObject(<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;cls,
                  <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>&nbsp;id)</pre>
 <div class="block">Returns the Object from the cache map with the id
  and Class type.</div>
 </li>
 </ul>
 <a name="putObject-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>putObject</h4>
 <pre><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>&nbsp;putObject(<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>&nbsp;object)</pre>
 <div class="block">ADVANCED:
  Puts the given Object into the cache.
  This is a very advanced method, and caution should be used in adding objects to the cache
  as other objects may have relationships to previous object, or this object may have
  relationships to other objects.</div>
 </li>
 </ul>
 <a name="removeObject-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>removeObject</h4>
 <pre><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>&nbsp;removeObject(<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>&nbsp;object)</pre>
 <div class="block">ADVANCED:
  Removes the Object from the cache.
  <p> NOTE: Caution should be used when calling to avoid violating Object identity.
  The application should only call this if its known that no references to the Object exist.</div>
 </li>
 </ul>
 <a name="removeObject-java.lang.Class-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>removeObject</h4>
 <pre><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>&nbsp;removeObject(<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;cls,
                     <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>&nbsp;id)</pre>
 <div class="block">ADVANCED:
  Removes the Object with the id and Class type from the cache.
  <p> NOTE: Caution should be used when calling to avoid violating Object identity.
  The application should only call this if its known that no references to the Object exist.</div>
 </li>
 </ul>
 <a name="contains-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>contains</h4>
 <pre>boolean&nbsp;contains(<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>&nbsp;object)</pre>
 <div class="block">Returns true if the cache contains an Object with the same id and Class type of the given object.</div>
 </li>
 </ul>
 <a name="evict-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>evict</h4>
 <pre>void&nbsp;evict(<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>&nbsp;object)</pre>
 <div class="block">Sets an Object to be invalid in the cache.</div>
 </li>
 </ul>
 <a name="evict-java.lang.Object-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>evict</h4>
 <pre>void&nbsp;evict(<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>&nbsp;object,
            boolean&nbsp;invalidateInCluster)</pre>
 <div class="block">Sets an Object to be invalid in the cache.
  If true is passed, the object is also invalidated across cache coordination.
  Cache coordination must be enabled for this to have an affect.</div>
 </li>
 </ul>
 <a name="evict-java.lang.Class-java.lang.Object-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>evict</h4>
 <pre>void&nbsp;evict(<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;classToEvict,
            <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>&nbsp;id,
            boolean&nbsp;invalidateInCluster)</pre>
 <div class="block">Sets the object of the class and id to be invalid in the cache.
  If true is passed, the object is also invalidated across cache coordination.
  Cache coordination must be enabled for this to have an affect.</div>
 </li>
 </ul>
 <a name="getId-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getId</h4>
 <pre><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>&nbsp;getId(<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>&nbsp;object)</pre>
 <div class="block">Returns the object's Id.</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/jpa/ArchiveFactory.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/jpa/JpaCriteriaBuilder.html" title="interface in org.eclipse.persistence.jpa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/jpa/JpaCache.html" target="_top">Frames</a></li>
 <li><a href="JpaCache.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>Field&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>Field&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 ======= -->
 <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>