Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / util / MapChangeTracker.html
blob: ef8574d0dc546eae9babb4360338d90049b43fe9 [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 (version 1.7.0_121) on Fri Jan 06 19:36:24 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MapChangeTracker (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MapChangeTracker (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/MapChangeTracker.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/util/LRSProxy.html" title="interface in org.apache.openjpa.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/util/MapChangeTrackerImpl.html" title="class in org.apache.openjpa.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/util/MapChangeTracker.html" target="_top">Frames</a></li>
<li><a href="MapChangeTracker.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.util</div>
<h2 title="Interface MapChangeTracker" class="title">Interface MapChangeTracker</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/util/ChangeTracker.html" title="interface in org.apache.openjpa.util">ChangeTracker</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/util/AbstractLRSProxyMap.html" title="class in org.apache.openjpa.util">AbstractLRSProxyMap</a>, <a href="../../../../org/apache/openjpa/util/MapChangeTrackerImpl.html" title="class in org.apache.openjpa.util">MapChangeTrackerImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">MapChangeTracker</span>
extends <a href="../../../../org/apache/openjpa/util/ChangeTracker.html" title="interface in org.apache.openjpa.util">ChangeTracker</a></pre>
<div class="block">Change tracker that can be used for maps. If the user calls
any mutating methods on the map that do not have an equivalent in
this change tracker, then you must call <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#stopTracking()"><code>ChangeTracker.stopTracking()</code></a>
after applying the operation to the map. The collections returned from
<a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getAdded()"><code>ChangeTracker.getAdded()</code></a> and <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getRemoved()"><code>ChangeTracker.getRemoved()</code></a> will
be collections of keys to add/remove.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/MapChangeTracker.html#added(java.lang.Object,%20java.lang.Object)">added</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">Record that the given entry was added to the map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/MapChangeTracker.html#changed(java.lang.Object,%20java.lang.Object,%20java.lang.Object)">changed</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;oldVal,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;newVal)</code>
<div class="block">Record that the given entry was altered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/MapChangeTracker.html#getTrackKeys()">getTrackKeys</a></strong>()</code>
<div class="block">Whether to track keys or values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/MapChangeTracker.html#removed(java.lang.Object,%20java.lang.Object)">removed</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">Record that the given entry was removed from the map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/MapChangeTracker.html#setTrackKeys(boolean)">setTrackKeys</a></strong>(boolean&nbsp;keys)</code>
<div class="block">Whether to track keys or values.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.util.ChangeTracker">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.util.<a href="../../../../org/apache/openjpa/util/ChangeTracker.html" title="interface in org.apache.openjpa.util">ChangeTracker</a></h3>
<code><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getAdded()">getAdded</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getChanged()">getChanged</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getNextSequence()">getNextSequence</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getRemoved()">getRemoved</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#isTracking()">isTracking</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#setNextSequence(int)">setNextSequence</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#startTracking()">startTracking</a>, <a href="../../../../org/apache/openjpa/util/ChangeTracker.html#stopTracking()">stopTracking</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTrackKeys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrackKeys</h4>
<pre>boolean&nbsp;getTrackKeys()</pre>
<div class="block">Whether to track keys or values. Defaults to keys.
If you set to values, it is assumed there is a 1-1 correlation
between keys and values in this map.</div>
</li>
</ul>
<a name="setTrackKeys(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTrackKeys</h4>
<pre>void&nbsp;setTrackKeys(boolean&nbsp;keys)</pre>
<div class="block">Whether to track keys or values. Defaults to keys.
If you set to values, it is assumed there is a 1-1 correlation
between keys and values in this map.</div>
</li>
</ul>
<a name="added(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>added</h4>
<pre>void&nbsp;added(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</pre>
<div class="block">Record that the given entry was added to the map.</div>
</li>
</ul>
<a name="removed(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removed</h4>
<pre>void&nbsp;removed(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</pre>
<div class="block">Record that the given entry was removed from the map.</div>
</li>
</ul>
<a name="changed(java.lang.Object, java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>changed</h4>
<pre>void&nbsp;changed(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;oldVal,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;newVal)</pre>
<div class="block">Record that the given entry was altered.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/MapChangeTracker.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/util/LRSProxy.html" title="interface in org.apache.openjpa.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/util/MapChangeTrackerImpl.html" title="class in org.apache.openjpa.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/util/MapChangeTracker.html" target="_top">Frames</a></li>
<li><a href="MapChangeTracker.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>