blob: a59bcb2e8c38cd22cc451e5f970b814f2d83710a [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 (1.8.0_252) on Fri Jul 16 09:39:10 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CacheInterceptor (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="CacheInterceptor (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10,"i8":10,"i9":10,"i10":6,"i11":10,"i12":10,"i13":6,"i14":6,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html" title="class in org.eclipse.persistence.sessions.interceptors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html" target="_top">Frames</a></li>
<li><a href="CacheInterceptor.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.sessions.interceptors</div>
<h2 title="Class CacheInterceptor" class="title">Class CacheInterceptor</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.sessions.interceptors.CacheInterceptor</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/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, org.eclipse.persistence.internal.identitymaps.IdentityMap</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">CacheInterceptor</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 org.eclipse.persistence.internal.identitymaps.IdentityMap</pre>
<div class="block"><p>
<b>Purpose</b>: Define a class through which Cache access can be
intercepted.
<p>
<b>Description</b>: EclipseLink makes extensive use of caching
functionality. This class provides the mechanism for intercepting the cache
access. Once intercepted applications can allow the process to continue by
calling the method on the class attribute targetIdentityMap as described in
the API javadocs or redirect the process entirely. * As with IdentityMaps an
entire class inheritance hierarchy will share the same interceptor.
<p>
To implement a CacheInterceptor users should subclass this class implementing
those methods they wish to intercept.
<p>
<b>Configuration</b>: Interceptors may be added to a session by using a
Session or Descriptor customizer to set the class name of the interceptor on
the target ClassDescriptor through the method
setCacheInterceptorClass(Class).</div>
</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 org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#interceptedSession">interceptedSession</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.identitymaps.IdentityMap</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#targetIdentityMap">targetIdentityMap</a></span></code>
<div class="block">This attribute stores the actual IdentityMap as configured by the user.</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/sessions/interceptors/CacheInterceptor.html#CacheInterceptor-org.eclipse.persistence.internal.identitymaps.IdentityMap-org.eclipse.persistence.internal.sessions.AbstractSession-">CacheInterceptor</a></span>(org.eclipse.persistence.internal.identitymaps.IdentityMap&nbsp;targetIdentityMap,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;interceptedSession)</code>&nbsp;</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#acquireDeferredLock-java.lang.Object-boolean-">acquireDeferredLock</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;primaryKey,
boolean&nbsp;isCacheCheckComplete)</code>
<div class="block">Acquire a deferred lock on the object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#acquireLock-java.lang.Object-boolean-boolean-">acquireLock</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;primaryKey,
boolean&nbsp;forMerge,
boolean&nbsp;isCacheCheckComplete)</code>
<div class="block">Acquire an active lock on the object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#acquireLockNoWait-java.lang.Object-boolean-">acquireLockNoWait</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;primaryKey,
boolean&nbsp;forMerge)</code>
<div class="block">Acquire an active lock on the object, if not already locked.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#acquireLockWithWait-java.lang.Object-boolean-int-">acquireLockWithWait</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;primaryKey,
boolean&nbsp;forMerge,
int&nbsp;wait)</code>
<div class="block">Acquire an active lock on the object, if not already locked.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#acquireReadLockOnCacheKey-java.lang.Object-">acquireReadLockOnCacheKey</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;primaryKey)</code>
<div class="block">Acquire a read lock on the object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#acquireReadLockOnCacheKeyNoWait-java.lang.Object-">acquireReadLockOnCacheKeyNoWait</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;primaryKey)</code>
<div class="block">Acquire a read lock on the object, if not already locked.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <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/sessions/interceptors/CacheInterceptor.html#clone--">clone</a></span>()</code>
<div class="block">Clone the map and all of the CacheKeys.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;org.eclipse.persistence.internal.identitymaps.CacheKey&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#cloneKeys--">cloneKeys</a></span>()</code>
<div class="block">Allow for the <code>CacheKey</code> elements to be iterated.</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/sessions/interceptors/CacheInterceptor.html#collectLocks-java.util.HashMap-">collectLocks</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&nbsp;threadList)</code>
<div class="block">Add all locked CacheKeys to the map grouped by thread.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#containsKey-java.lang.Object-">containsKey</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;primaryKey)</code>
<div class="block">Return true if an CacheKey with the primary key is in the map.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html" title="class in org.eclipse.persistence.sessions.interceptors">CacheKeyInterceptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#createCacheKeyInterceptor-org.eclipse.persistence.internal.identitymaps.CacheKey-">createCacheKeyInterceptor</a></span>(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;wrappedCacheKey)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#elements--">elements</a></span>()</code>
<div class="block">Allow for the cache to be iterated on.</div>
</td>
</tr>
<tr id="i12" 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/sessions/interceptors/CacheInterceptor.html#get-java.lang.Object-">get</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;primaryKey)</code>
<div class="block">Return the object cached in the identity map or null if it could not be found.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,org.eclipse.persistence.internal.identitymaps.CacheKey&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getAllCacheKeysFromIdentityMapWithEntityPK-java.lang.Object:A-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">getAllCacheKeysFromIdentityMapWithEntityPK</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;pkList,
<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">ADVANCED:
Using a list of Entity PK this method will attempt to bulk load the entire list from the cache.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getAllFromIdentityMapWithEntityPK-java.lang.Object:A-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">getAllFromIdentityMapWithEntityPK</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;pkList,
<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">ADVANCED:
Using a list of Entity PK this method will attempt to bulk load the entire list from the cache.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getCacheKey-java.lang.Object-boolean-">getCacheKey</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;primaryKey,
boolean&nbsp;forMerge)</code>
<div class="block">Get the cache key (with object) for the primary key.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getCacheKeyForLock-java.lang.Object-">getCacheKeyForLock</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;primaryKey)</code>
<div class="block">Get the cache key (with object) for the primary key.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getDescriptor--">getDescriptor</a></span>()</code>
<div class="block">Return the descriptor that this is the map for.</div>
</td>
</tr>
<tr id="i18" 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/sessions/interceptors/CacheInterceptor.html#getDescriptorClass--">getDescriptorClass</a></span>()</code>
<div class="block">Return the class that this is the map for.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getMaxSize--">getMaxSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getSize--">getSize</a></span>()</code>
<div class="block">Return the number of CacheKeys in the IdentityMap.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getSize-java.lang.Class-boolean-">getSize</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;myClass,
boolean&nbsp;recurse)</code>
<div class="block">Return the number of actual objects of type myClass in the IdentityMap.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#getTargetIdenttyMap--">getTargetIdenttyMap</a></span>()</code>
<div class="block">Return the instance of the IdentityMap that this intercpetor is wrapping.</div>
</td>
</tr>
<tr id="i23" 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/sessions/interceptors/CacheInterceptor.html#getWrapper-java.lang.Object-">getWrapper</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;primaryKey)</code>
<div class="block">Get the wrapper object from the cache key associated with the given primary key,
this is used for EJB2.</div>
</td>
</tr>
<tr id="i24" 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/sessions/interceptors/CacheInterceptor.html#getWriteLockValue-java.lang.Object-">getWriteLockValue</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;primaryKey)</code>
<div class="block">Get the write lock value from the cache key associated to the primarykey.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;org.eclipse.persistence.internal.identitymaps.CacheKey&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#keys--">keys</a></span>()</code>
<div class="block">Allow for the <code>CacheKey</code> elements to be iterated.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;org.eclipse.persistence.internal.identitymaps.CacheKey&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#keys-boolean-">keys</a></span>(boolean&nbsp;checkReadLocks)</code>
<div class="block">Allow for the <code>CacheKey</code> elements to be iterated.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#lazyRelationshipLoaded-java.lang.Object-org.eclipse.persistence.indirection.ValueHolderInterface-org.eclipse.persistence.mappings.ForeignReferenceMapping-">lazyRelationshipLoaded</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;rootEntity,
<a href="../../../../../org/eclipse/persistence/indirection/ValueHolderInterface.html" title="interface in org.eclipse.persistence.indirection">ValueHolderInterface</a>&nbsp;valueHolder,
<a href="../../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html" title="class in org.eclipse.persistence.mappings">ForeignReferenceMapping</a>&nbsp;mapping)</code>
<div class="block">Notify the cache that a lazy relationship has been triggered in the object
and the cache may need to be updated</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#put-java.lang.Object-java.lang.Object-java.lang.Object-long-">put</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;primaryKey,
<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,
<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;writeLockValue,
long&nbsp;readTime)</code>
<div class="block">Store the object in the cache at its primary key.</div>
</td>
</tr>
<tr id="i29" 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/sessions/interceptors/CacheInterceptor.html#remove-org.eclipse.persistence.internal.identitymaps.CacheKey-">remove</a></span>(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey)</code>
<div class="block">Remove the CacheKey from the map.</div>
</td>
</tr>
<tr id="i30" 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/sessions/interceptors/CacheInterceptor.html#remove-java.lang.Object-java.lang.Object-">remove</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;primaryKey,
<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">Remove the CacheKey with the primaryKey from the map.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a></span>(<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor)</code>
<div class="block">Set the descriptor that this is the map for.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#setWrapper-java.lang.Object-java.lang.Object-">setWrapper</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;primaryKey,
<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;wrapper)</code>
<div class="block">Update the wrapper object in the CacheKey associated with the given primaryKey,
this is used for EJB2.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#setWriteLockValue-java.lang.Object-java.lang.Object-">setWriteLockValue</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;primaryKey,
<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;writeLockValue)</code>
<div class="block">Update the write lock value of the CacheKey associated with the given primaryKey.</div>
</td>
</tr>
<tr id="i34" 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/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html#updateMaxSize-int-">updateMaxSize</a></span>(int&nbsp;maxSize)</code>
<div class="block">This method will be used to update the max cache size, any objects exceeding the max cache size will
be remove from the cache.</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#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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.internal.identitymaps.IdentityMap">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.persistence.internal.identitymaps.IdentityMap</h3>
<code>release</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="targetIdentityMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetIdentityMap</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.identitymaps.IdentityMap targetIdentityMap</pre>
<div class="block">This attribute stores the actual IdentityMap as configured by the user.</div>
</li>
</ul>
<a name="interceptedSession">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>interceptedSession</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession interceptedSession</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CacheInterceptor-org.eclipse.persistence.internal.identitymaps.IdentityMap-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CacheInterceptor</h4>
<pre>public&nbsp;CacheInterceptor(org.eclipse.persistence.internal.identitymaps.IdentityMap&nbsp;targetIdentityMap,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;interceptedSession)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="acquireDeferredLock-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireDeferredLock</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;acquireDeferredLock(<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;primaryKey,
boolean&nbsp;isCacheCheckComplete)</pre>
<div class="block">Acquire a deferred lock on the object.
This is used while reading if the object has relationships without indirection.
This first thread will get an active lock.
Other threads will get deferred locks, all threads will wait until all other threads are complete before releasing their locks.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>acquireDeferredLock</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="acquireLock-java.lang.Object-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireLock</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;acquireLock(<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;primaryKey,
boolean&nbsp;forMerge,
boolean&nbsp;isCacheCheckComplete)</pre>
<div class="block">Acquire an active lock on the object.
This is used by reading (when using indirection or no relationships) and by merge.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>acquireLock</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="acquireLockNoWait-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireLockNoWait</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;acquireLockNoWait(<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;primaryKey,
boolean&nbsp;forMerge)</pre>
<div class="block">Acquire an active lock on the object, if not already locked.
This is used by merge for missing existing objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>acquireLockNoWait</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="acquireLockWithWait-java.lang.Object-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireLockWithWait</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;acquireLockWithWait(<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;primaryKey,
boolean&nbsp;forMerge,
int&nbsp;wait)</pre>
<div class="block">Acquire an active lock on the object, if not already locked.
This is used by merge for missing existing objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>acquireLockWithWait</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="acquireReadLockOnCacheKey-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireReadLockOnCacheKey</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;acquireReadLockOnCacheKey(<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;primaryKey)</pre>
<div class="block">Acquire a read lock on the object.
This is used by UnitOfWork cloning.
This will allow multiple users to read the same object but prevent writes to the object while the read lock is held.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>acquireReadLockOnCacheKey</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="acquireReadLockOnCacheKeyNoWait-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireReadLockOnCacheKeyNoWait</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;acquireReadLockOnCacheKeyNoWait(<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;primaryKey)</pre>
<div class="block">Acquire a read lock on the object, if not already locked.
This is used by UnitOfWork cloning.
This will allow multiple users to read the same object but prevent writes to the object while the read lock is held.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>acquireReadLockOnCacheKeyNoWait</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="collectLocks-java.util.HashMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectLocks</h4>
<pre>public&nbsp;void&nbsp;collectLocks(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&nbsp;threadList)</pre>
<div class="block">Add all locked CacheKeys to the map grouped by thread.
Used to print all the locks in the identity map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>collectLocks</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public abstract&nbsp;<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;clone()</pre>
<div class="block">Clone the map and all of the CacheKeys.
This is used by UnitOfWork commitAndResumeOnFailure to avoid corrupting the cache during a failed commit.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<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="containsKey-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsKey</h4>
<pre>public&nbsp;boolean&nbsp;containsKey(<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;primaryKey)</pre>
<div class="block">Return true if an CacheKey with the primary key is in the map.
User API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>containsKey</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>primaryKey</code> - is the primary key for the object to search for.</dd>
</dl>
</li>
</ul>
<a name="createCacheKeyInterceptor-org.eclipse.persistence.internal.identitymaps.CacheKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCacheKeyInterceptor</h4>
<pre>protected abstract&nbsp;<a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html" title="class in org.eclipse.persistence.sessions.interceptors">CacheKeyInterceptor</a>&nbsp;createCacheKeyInterceptor(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;wrappedCacheKey)</pre>
</li>
</ul>
<a name="elements--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>elements</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&nbsp;elements()</pre>
<div class="block">Allow for the cache to be iterated on. This method is only used during debugging when
validateCache() has been called to print out the contents of the cache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>elements</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="get-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;<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;get(<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;primaryKey)</pre>
<div class="block">Return the object cached in the identity map or null if it could not be found.
User API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>get</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getAllFromIdentityMapWithEntityPK-java.lang.Object:A-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllFromIdentityMapWithEntityPK</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;getAllFromIdentityMapWithEntityPK(<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;pkList,
<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">ADVANCED:
Using a list of Entity PK this method will attempt to bulk load the entire list from the cache.
In certain circumstances this can have large performance improvements over loading each item individually.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAllFromIdentityMapWithEntityPK</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pkList</code> - List of Entity PKs to extract from the cache</dd>
<dd><code>descriptor</code> - Descriptor type to be retrieved.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of Entity PKs associated to the Entities that were retrieved</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAllCacheKeysFromIdentityMapWithEntityPK-java.lang.Object:A-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllCacheKeysFromIdentityMapWithEntityPK</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,org.eclipse.persistence.internal.identitymaps.CacheKey&gt;&nbsp;getAllCacheKeysFromIdentityMapWithEntityPK(<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;pkList,
<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">ADVANCED:
Using a list of Entity PK this method will attempt to bulk load the entire list from the cache.
In certain circumstances this can have large performance improvements over loading each item individually.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAllCacheKeysFromIdentityMapWithEntityPK</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pkList</code> - List of Entity PKs to extract from the cache</dd>
<dd><code>descriptor</code> - Descriptor type to be retrieved.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of Entity PKs associated to the Entities that were retrieved</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
</dl>
</li>
</ul>
<a name="getCacheKey-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheKey</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;getCacheKey(<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;primaryKey,
boolean&nbsp;forMerge)</pre>
<div class="block">Get the cache key (with object) for the primary key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getCacheKey</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getCacheKeyForLock-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheKeyForLock</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;getCacheKeyForLock(<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;primaryKey)</pre>
<div class="block">Get the cache key (with object) for the primary key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getCacheKeyForLock</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescriptor</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;getDescriptor()</pre>
<div class="block">Return the descriptor that this is the map for.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getDescriptor</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getDescriptorClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescriptorClass</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;getDescriptorClass()</pre>
<div class="block">Return the class that this is the map for.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getDescriptorClass</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getMaxSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxSize</h4>
<pre>public&nbsp;int&nbsp;getMaxSize()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getMaxSize</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The maxSize for the IdentityMap (NOTE: some subclasses may use this differently).</dd>
</dl>
</li>
</ul>
<a name="getSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;getSize()</pre>
<div class="block">Return the number of CacheKeys in the IdentityMap.
This may contain weak referenced objects that have been garbage collected.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getSize</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getSize-java.lang.Class-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;int&nbsp;getSize(<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;myClass,
boolean&nbsp;recurse)</pre>
<div class="block">Return the number of actual objects of type myClass in the IdentityMap.
Recurse = true will include subclasses of myClass in the count.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getSize</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getTargetIdenttyMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetIdenttyMap</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.IdentityMap&nbsp;getTargetIdenttyMap()</pre>
<div class="block">Return the instance of the IdentityMap that this intercpetor is wrapping. Any call that
is to be passed on to the underlying EclipseLink cache should be passed to this IdentityMap.</div>
</li>
</ul>
<a name="getWrapper-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrapper</h4>
<pre>public&nbsp;<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;getWrapper(<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;primaryKey)</pre>
<div class="block">Get the wrapper object from the cache key associated with the given primary key,
this is used for EJB2.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getWrapper</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="getWriteLockValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteLockValue</h4>
<pre>public&nbsp;<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;getWriteLockValue(<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;primaryKey)</pre>
<div class="block">Get the write lock value from the cache key associated to the primarykey.
User API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getWriteLockValue</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="keys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keys</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;org.eclipse.persistence.internal.identitymaps.CacheKey&gt;&nbsp;keys()</pre>
<div class="block">Allow for the <code>CacheKey</code> elements to be iterated.
<code>CacheKey</code> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> is reused so this iteration may not be thread safe.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>keys</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util"><code>Enumeration</code></a> of <code>CacheKey</code> instances.</dd>
</dl>
</li>
</ul>
<a name="cloneKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneKeys</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;org.eclipse.persistence.internal.identitymaps.CacheKey&gt;&nbsp;cloneKeys()</pre>
<div class="block">Allow for the <code>CacheKey</code> elements to be iterated.
Clone of <code>CacheKey</code> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> is returned so this iteration should
be thread safe.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>cloneKeys</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util"><code>Enumeration</code></a> with clone of the <code>CacheKey</code> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a></dd>
</dl>
</li>
</ul>
<a name="keys-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keys</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;org.eclipse.persistence.internal.identitymaps.CacheKey&gt;&nbsp;keys(boolean&nbsp;checkReadLocks)</pre>
<div class="block">Allow for the <code>CacheKey</code> elements to be iterated.
<code>CacheKey</code> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> is reused so this iteration may not be thread safe.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>keys</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>checkReadLocks</code> - value of <code>true</code> if read lock on the <code>CacheKey</code>
instances should be checked or <code>false</code> otherwise</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util"><code>Enumeration</code></a> of <code>CacheKey</code> instances.</dd>
</dl>
</li>
</ul>
<a name="lazyRelationshipLoaded-java.lang.Object-org.eclipse.persistence.indirection.ValueHolderInterface-org.eclipse.persistence.mappings.ForeignReferenceMapping-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lazyRelationshipLoaded</h4>
<pre>public&nbsp;void&nbsp;lazyRelationshipLoaded(<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;rootEntity,
<a href="../../../../../org/eclipse/persistence/indirection/ValueHolderInterface.html" title="interface in org.eclipse.persistence.indirection">ValueHolderInterface</a>&nbsp;valueHolder,
<a href="../../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html" title="class in org.eclipse.persistence.mappings">ForeignReferenceMapping</a>&nbsp;mapping)</pre>
<div class="block">Notify the cache that a lazy relationship has been triggered in the object
and the cache may need to be updated</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>lazyRelationshipLoaded</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="put-java.lang.Object-java.lang.Object-java.lang.Object-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;put(<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;primaryKey,
<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,
<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;writeLockValue,
long&nbsp;readTime)</pre>
<div class="block">Store the object in the cache at its primary key.
This is used by InsertObjectQuery, typically into the UnitOfWork identity map.
Merge and reads do not use put, but acquireLock.
Also an advanced (very) user API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>put</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>primaryKey</code> - is the primary key for the object.</dd>
<dd><code>object</code> - is the domain object to cache.</dd>
<dd><code>writeLockValue</code> - is the current write lock value of object, if null the version is ignored.</dd>
</dl>
</li>
</ul>
<a name="remove-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;<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;remove(<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;primaryKey,
<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">Remove the CacheKey with the primaryKey from the map.
This is used by DeleteObjectQuery and merge.
This is also an advanced (very) user API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>remove</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="remove-org.eclipse.persistence.internal.identitymaps.CacheKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;<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;remove(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey)</pre>
<div class="block">Remove the CacheKey from the map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>remove</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="updateMaxSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateMaxSize</h4>
<pre>public&nbsp;void&nbsp;updateMaxSize(int&nbsp;maxSize)</pre>
<div class="block">This method will be used to update the max cache size, any objects exceeding the max cache size will
be remove from the cache. Please note that this does not remove the object from the identityMap, except in
the case of the CacheIdentityMap.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>updateMaxSize</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescriptor</h4>
<pre>public&nbsp;void&nbsp;setDescriptor(<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor)</pre>
<div class="block">Set the descriptor that this is the map for.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setDescriptor</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="setWrapper-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWrapper</h4>
<pre>public&nbsp;void&nbsp;setWrapper(<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;primaryKey,
<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;wrapper)</pre>
<div class="block">Update the wrapper object in the CacheKey associated with the given primaryKey,
this is used for EJB2.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setWrapper</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
</dl>
</li>
</ul>
<a name="setWriteLockValue-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWriteLockValue</h4>
<pre>public&nbsp;void&nbsp;setWriteLockValue(<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;primaryKey,
<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;writeLockValue)</pre>
<div class="block">Update the write lock value of the CacheKey associated with the given primaryKey.
This is used by UpdateObjectQuery, and is also an advanced (very) user API.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setWriteLockValue</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>toString</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.identitymaps.IdentityMap</code></dd>
<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>
</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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html" title="class in org.eclipse.persistence.sessions.interceptors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html" target="_top">Frames</a></li>
<li><a href="CacheInterceptor.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>