Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / refs/heads/master / . / api / 3.0 / org / eclipse / persistence / sessions / interceptors / CacheKeyInterceptor.html
blob: 4c2c579558518396d8a44d77e06d4c25d801c5a2 [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>CacheKeyInterceptor (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="CacheKeyInterceptor (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"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,"i36":10,"i37":10,"i38":10,"i39":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html" title="class in org.eclipse.persistence.sessions.interceptors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html" target="_top">Frames</a></li>
<li><a href="CacheKeyInterceptor.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 CacheKeyInterceptor" class="title">Class CacheKeyInterceptor</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.internal.helper.ConcurrencyManager</li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.internal.identitymaps.CacheKey</li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.sessions.interceptors.CacheKeyInterceptor</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CacheKeyInterceptor</span>
extends org.eclipse.persistence.internal.identitymaps.CacheKey</pre>
<div class="block">The CacheKeyInterceptor allows a Cache Interceptor implementation to wrap the EclipseLink CacheKey.
The CacheKey is an object that wraps the object and maintains cached based information about the object
like primary key, write lock value and locking. The EclipseLink runtime will access the CacheKey and directly
when releasing locks.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.sessions.interceptors.CacheKeyInterceptor">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Gordon Yorke</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.identitymaps.CacheKey</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#wrappedKey">wrappedKey</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.internal.identitymaps.CacheKey">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey</h3>
<code>CACHE_KEY_INVALID, CHECK_INVALIDATION_POLICY, CREATION_THREAD_HASHCODE, CREATION_THREAD_ID, CREATION_THREAD_NAME, invalidationState, isIsolated, isWrapper, key, lastUpdatedQueryId, mapOwner, MAX_WAIT_TRIES, object, protectedForeignKeys, readTime, record, transactionId, wrapper, writeLockValue</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.internal.helper.ConcurrencyManager">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.internal.helper.ConcurrencyManager</h3>
<code>activeThread, DEFERRED_LOCK_MANAGERS, depth, lockedByMergeManager, numberOfReaders, numberOfWritersWaiting, shouldTrackStack, stack</code></li>
</ul>
</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/CacheKeyInterceptor.html#CacheKeyInterceptor-org.eclipse.persistence.internal.identitymaps.CacheKey-">CacheKeyInterceptor</a></span>(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey)</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#acquire--">acquire</a></span>()</code>
<div class="block">Acquire the lock on the cache key object.</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/sessions/interceptors/CacheKeyInterceptor.html#acquire-boolean-">acquire</a></span>(boolean&nbsp;forMerge)</code>
<div class="block">Acquire the lock on the cache key object.</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/sessions/interceptors/CacheKeyInterceptor.html#acquireDeferredLock--">acquireDeferredLock</a></span>()</code>
<div class="block">Acquire the deferred lock.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#acquireIfUnownedNoWait--">acquireIfUnownedNoWait</a></span>()</code>
<div class="block">Acquire the lock on the cache key object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#acquireNoWait--">acquireNoWait</a></span>()</code>
<div class="block">Acquire the lock on the cache key object.</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/sessions/interceptors/CacheKeyInterceptor.html#acquireNoWait-boolean-">acquireNoWait</a></span>(boolean&nbsp;forMerge)</code>
<div class="block">Acquire the lock on the cache key 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/sessions/interceptors/CacheKeyInterceptor.html#acquireReadLock--">acquireReadLock</a></span>()</code>
<div class="block">Acquire the read lock on the cache key object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#acquireReadLockNoWait--">acquireReadLockNoWait</a></span>()</code>
<div class="block">Acquire the read lock on the cache key object.</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/CacheKeyInterceptor.html#checkDeferredLock--">checkDeferredLock</a></span>()</code>
<div class="block">Check the deferred lock on the cache key object.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#checkReadLock--">checkReadLock</a></span>()</code>
<div class="block">Check the read lock on the cache key object.</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/sessions/interceptors/CacheKeyInterceptor.html#clone--">clone</a></span>()</code>
<div class="block">INTERNAL:
Clones itself.</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/sessions/interceptors/CacheKeyInterceptor.html#equals-org.eclipse.persistence.internal.identitymaps.CacheKey-">equals</a></span>(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;key)</code>
<div class="block">Determine if the receiver is equal to key.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#getActiveThread--">getActiveThread</a></span>()</code>
<div class="block">Return the active thread.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#getInvalidationState--">getInvalidationState</a></span>()</code>
<div class="block">INTERNAL:
Return the value of the invalidationState Variable
The return value will be a constant
CHECK_INVALIDATION_POLICY - The Invalidation policy is must be checked for this cache key's sate
CACHE_KEY_INVALID - This cache key has been labeled invalid.</div>
</td>
</tr>
<tr id="i14" 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/CacheKeyInterceptor.html#getKey--">getKey</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#getLastUpdatedQueryId--">getLastUpdatedQueryId</a></span>()</code>
<div class="block">INTERNAL:
This method returns the system time in millis seconds at which this object was last refreshed
CR #4365
CR #2698903 ...</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/sessions/interceptors/CacheKeyInterceptor.html#getObject--">getObject</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<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/CacheKeyInterceptor.html#getOwningMap--">getOwningMap</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#getReadTime--">getReadTime</a></span>()</code>
<div class="block">INTERNAL:
Return the current value of the Read Time variable</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#getRecord--">getRecord</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" 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/CacheKeyInterceptor.html#getWrappedCacheKey--">getWrappedCacheKey</a></span>()</code>
<div class="block">If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.</div>
</td>
</tr>
<tr id="i21" 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/CacheKeyInterceptor.html#getWrapper--">getWrapper</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i22" 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/CacheKeyInterceptor.html#getWriteLockValue--">getWriteLockValue</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#isAcquired--">isAcquired</a></span>()</code>
<div class="block">Return if a thread has acquire this manager.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#release--">release</a></span>()</code>
<div class="block">Release the lock on the cache key object.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#releaseDeferredLock--">releaseDeferredLock</a></span>()</code>
<div class="block">Release the deferred lock</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/CacheKeyInterceptor.html#releaseReadLock--">releaseReadLock</a></span>()</code>
<div class="block">Release the read lock on the cache key object.</div>
</td>
</tr>
<tr id="i28" 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/CacheKeyInterceptor.html#removeFromOwningMap--">removeFromOwningMap</a></span>()</code>
<div class="block">Removes this cacheKey from the owning map</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#setInvalidationState-int-">setInvalidationState</a></span>(int&nbsp;invalidationState)</code>
<div class="block">INTERNAL:
Set the value of the invalidationState Variable
The possible values are from an enumeration of constants
CHECK_INVALIDATION_POLICY - The invalidation policy is must be checked for this cache key's sate
CACHE_KEY_INVALID - This cache key has been labelled invalid.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#setKey-java.lang.Object-">setKey</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;key)</code>&nbsp;</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/CacheKeyInterceptor.html#setLastUpdatedQueryId-long-">setLastUpdatedQueryId</a></span>(long&nbsp;id)</code>
<div class="block">INTERNAL:
This method sets the system time in millis seconds at which this object was last refreshed
CR #4365
CR #2698903 ...</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/CacheKeyInterceptor.html#setObject-java.lang.Object-">setObject</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>&nbsp;</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/CacheKeyInterceptor.html#setOwningMap-org.eclipse.persistence.internal.identitymaps.AbstractIdentityMap-">setOwningMap</a></span>(org.eclipse.persistence.internal.identitymaps.AbstractIdentityMap&nbsp;map)</code>&nbsp;</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#setReadTime-long-">setReadTime</a></span>(long&nbsp;readTime)</code>
<div class="block">INTERNAL:
Set the read time of this cache key</div>
</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/CacheKeyInterceptor.html#setRecord-org.eclipse.persistence.sessions.Record-">setRecord</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a>&nbsp;newRecord)</code>&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#setWrapper-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;wrapper)</code>&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#setWriteLockValue-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;writeLockValue)</code>&nbsp;</td>
</tr>
<tr id="i38" 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/CacheKeyInterceptor.html#toString--">toString</a></span>()</code>
<div class="block">Print the nested depth.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html#updateAccess--">updateAccess</a></span>()</code>
<div class="block">Notifies that cache key that it has been accessed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.internal.identitymaps.CacheKey">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey</h3>
<code>acquireLock, acquireWithWait, equals, getProtectedForeignKeys, getTransactionId, hasProtectedForeignKeys, isIsolated, isWrapper, setIsolated, setIsWrapper, setOwningMap, setProtectedForeignKeys, setTransactionId, waitForObject</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.internal.helper.ConcurrencyManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.internal.helper.ConcurrencyManager</h3>
<code>acquireIfUnownedNoWait, addReadLockToReadLockManager, clearJustificationWhyMethodIsBuildingObjectCompleteReturnsFalse, enrichStringBuildingExplainWhyThreadIsStuckInIsBuildObjectOnThreadComplete, getConcurrencyManagerCreationDate, getConcurrencyManagerId, getDeferredLockManager, getDeferredLockManagers, getDepth, getNumberOfReaders, getNumberOfWritersWaiting, getReadLockManager, getReadLockManagerEnsureResultIsNotNull, getReadLockManagers, getStack, getThreadsToWaitOnAcquire, getThreadsToWaitOnAcquireMethodName, getThreadsToWaitOnAcquireReadLock, getThreadsToWaitOnAcquireReadLockMethodName, getThreadsWaitingToReleaseDeferredLocks, getThreadsWaitingToReleaseDeferredLocksJustification, getTotalNumberOfKeysAcquiredForReading, getTotalNumberOfKeysReleasedForReading, getTotalNumberOfKeysReleasedForReadingBlewUpExceptionDueToCacheKeyHavingReachedCounterZero, initializeDeferredLockManagers, isBuildObjectOnThreadComplete, isLockedByMergeManager, isNested, putDeferredLock, putThreadAsWaitingToAcquireLockForReading, putThreadAsWaitingToAcquireLockForWriting, releaseAllLocksAcquiredByThread, removeDeferredLockManager, removeReadLockFromReadLockManager, removeReadLockManagerIfEmpty, removeThreadNoLongerWaitingToAcquireLockForReading, removeThreadNoLongerWaitingToAcquireLockForWriting, setActiveThread, setDepth, setIsLockedByMergeManager, setJustificationWhyMethodIsBuildingObjectCompleteReturnsFalse, setNumberOfReaders, setNumberOfWritersWaiting, setShouldTrackStack, setStack, shouldTrackStack, transitionToDeferredLock</code></li>
</ul>
<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#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#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="wrappedKey">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>wrappedKey</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey wrappedKey</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CacheKeyInterceptor-org.eclipse.persistence.internal.identitymaps.CacheKey-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CacheKeyInterceptor</h4>
<pre>public&nbsp;CacheKeyInterceptor(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;cacheKey)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="acquire--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquire</h4>
<pre>public&nbsp;void&nbsp;acquire()</pre>
<div class="block">Acquire the lock on the cache key object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquire</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquire-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquire</h4>
<pre>public&nbsp;void&nbsp;acquire(boolean&nbsp;forMerge)</pre>
<div class="block">Acquire the lock on the cache key object. For the merge process
called with true from the merge process, if true then the refresh will not refresh the object</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquire</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquireNoWait--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireNoWait</h4>
<pre>public&nbsp;boolean&nbsp;acquireNoWait()</pre>
<div class="block">Acquire the lock on the cache key object. But only if the object has no lock on it
Added for CR 2317</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquireNoWait</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquireIfUnownedNoWait--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireIfUnownedNoWait</h4>
<pre>public&nbsp;boolean&nbsp;acquireIfUnownedNoWait()</pre>
<div class="block">Acquire the lock on the cache key object. Only acquire a lock if the cache key's
active thread is not set.
Added for Bug 5840635</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquireIfUnownedNoWait</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquireNoWait-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireNoWait</h4>
<pre>public&nbsp;boolean&nbsp;acquireNoWait(boolean&nbsp;forMerge)</pre>
<div class="block">Acquire the lock on the cache key object. But only if the object has no lock on it
Added for CR 2317
called with true from the merge process, if true then the refresh will not refresh the object</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquireNoWait</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquireDeferredLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireDeferredLock</h4>
<pre>public&nbsp;void&nbsp;acquireDeferredLock()</pre>
<div class="block">Acquire the deferred lock.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquireDeferredLock</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="checkReadLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkReadLock</h4>
<pre>public&nbsp;void&nbsp;checkReadLock()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">Check the read lock on the cache key object.
This can be called to ensure the cache key has a valid built object.
It does not hold a lock, so the object could be refreshed afterwards.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>checkReadLock</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="checkDeferredLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkDeferredLock</h4>
<pre>public&nbsp;void&nbsp;checkDeferredLock()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">Check the deferred lock on the cache key object.
This can be called to ensure the cache key has a valid built object.
It does not hold a lock, so the object could be refreshed afterwards.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>checkDeferredLock</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquireReadLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireReadLock</h4>
<pre>public&nbsp;void&nbsp;acquireReadLock()</pre>
<div class="block">Acquire the read lock on the cache key object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquireReadLock</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="acquireReadLockNoWait--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireReadLockNoWait</h4>
<pre>public&nbsp;boolean&nbsp;acquireReadLockNoWait()</pre>
<div class="block">Acquire the read lock on the cache key object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>acquireReadLockNoWait</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getActiveThread--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveThread</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a>&nbsp;getActiveThread()</pre>
<div class="block">Return the active thread.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getActiveThread</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</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;clone()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">INTERNAL:
Clones itself.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="equals-org.eclipse.persistence.internal.identitymaps.CacheKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">Determine if the receiver is equal to key.
Use an index compare, because it is much faster than enumerations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getLastUpdatedQueryId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastUpdatedQueryId</h4>
<pre>public&nbsp;long&nbsp;getLastUpdatedQueryId()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">INTERNAL:
This method returns the system time in millis seconds at which this object was last refreshed
CR #4365
CR #2698903 ... instead of using millis we will now use id's instead. Method
renamed appropriately.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getLastUpdatedQueryId</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</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;getKey()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getKey</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</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;getObject()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getObject</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getOwningMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwningMap</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.IdentityMap&nbsp;getOwningMap()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getOwningMap</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getReadTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadTime</h4>
<pre>public&nbsp;long&nbsp;getReadTime()</pre>
<div class="block">INTERNAL:
Return the current value of the Read Time variable</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getReadTime</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getRecord--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a>&nbsp;getRecord()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getRecord</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getWrappedCacheKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrappedCacheKey</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.identitymaps.CacheKey&nbsp;getWrappedCacheKey()</pre>
<div class="block">If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getWrappedCacheKey</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getWrapper--">
<!-- -->
</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()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getWrapper</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="getWriteLockValue--">
<!-- -->
</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()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getWriteLockValue</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="isAcquired--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAcquired</h4>
<pre>public&nbsp;boolean&nbsp;isAcquired()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code></span></div>
<div class="block">Return if a thread has acquire this manager.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>isAcquired</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code></dd>
</dl>
</li>
</ul>
<a name="getInvalidationState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInvalidationState</h4>
<pre>public&nbsp;int&nbsp;getInvalidationState()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">INTERNAL:
Return the value of the invalidationState Variable
The return value will be a constant
CHECK_INVALIDATION_POLICY - The Invalidation policy is must be checked for this cache key's sate
CACHE_KEY_INVALID - This cache key has been labeled invalid.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getInvalidationState</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="release--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>release</h4>
<pre>public&nbsp;void&nbsp;release()</pre>
<div class="block">Release the lock on the cache key object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>release</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="releaseDeferredLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseDeferredLock</h4>
<pre>public&nbsp;void&nbsp;releaseDeferredLock()</pre>
<div class="block">Release the deferred lock</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>releaseDeferredLock</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="releaseReadLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseReadLock</h4>
<pre>public&nbsp;void&nbsp;releaseReadLock()</pre>
<div class="block">Release the read lock on the cache key object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>releaseReadLock</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="removeFromOwningMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFromOwningMap</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;removeFromOwningMap()</pre>
<div class="block">Removes this cacheKey from the owning map</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>removeFromOwningMap</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setInvalidationState-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInvalidationState</h4>
<pre>public&nbsp;void&nbsp;setInvalidationState(int&nbsp;invalidationState)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">INTERNAL:
Set the value of the invalidationState Variable
The possible values are from an enumeration of constants
CHECK_INVALIDATION_POLICY - The invalidation policy is must be checked for this cache key's sate
CACHE_KEY_INVALID - This cache key has been labelled invalid.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setInvalidationState</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setLastUpdatedQueryId-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLastUpdatedQueryId</h4>
<pre>public&nbsp;void&nbsp;setLastUpdatedQueryId(long&nbsp;id)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">INTERNAL:
This method sets the system time in millis seconds at which this object was last refreshed
CR #4365
CR #2698903 ... instead of using millis we will now use ids instead. Method
renamed appropriately.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setLastUpdatedQueryId</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setKey-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKey</h4>
<pre>public&nbsp;void&nbsp;setKey(<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;key)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setKey</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setObject-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObject</h4>
<pre>public&nbsp;void&nbsp;setObject(<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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setObject</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setOwningMap-org.eclipse.persistence.internal.identitymaps.AbstractIdentityMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOwningMap</h4>
<pre>public&nbsp;void&nbsp;setOwningMap(org.eclipse.persistence.internal.identitymaps.AbstractIdentityMap&nbsp;map)</pre>
</li>
</ul>
<a name="setReadTime-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadTime</h4>
<pre>public&nbsp;void&nbsp;setReadTime(long&nbsp;readTime)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">INTERNAL:
Set the read time of this cache key</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setReadTime</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setRecord-org.eclipse.persistence.sessions.Record-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecord</h4>
<pre>public&nbsp;void&nbsp;setRecord(<a href="../../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a>&nbsp;newRecord)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setRecord</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setWrapper-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;wrapper)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setWrapper</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="setWriteLockValue-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;writeLockValue)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setWriteLockValue</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.helper.ConcurrencyManager</code></span></div>
<div class="block">Print the nested depth.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></dd>
</dl>
</li>
</ul>
<a name="updateAccess--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>updateAccess</h4>
<pre>public&nbsp;void&nbsp;updateAccess()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</code></span></div>
<div class="block">Notifies that cache key that it has been accessed.
Allows the LRU sub-cache to be maintained.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>updateAccess</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.identitymaps.CacheKey</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><a href="../../../../../org/eclipse/persistence/sessions/interceptors/CacheInterceptor.html" title="class in org.eclipse.persistence.sessions.interceptors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/interceptors/CacheKeyInterceptor.html" target="_top">Frames</a></li>
<li><a href="CacheKeyInterceptor.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>