blob: fcddb15bd806d4b3be0e5bab24ad4f6de0b0a379 [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>Proxy (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="Proxy (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/Proxy.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/Proxies.html" title="class in org.apache.openjpa.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/util/ProxyBean.html" title="interface 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/Proxy.html" target="_top">Frames</a></li>
<li><a href="Proxy.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 Proxy" class="title">Interface Proxy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/util/LRSProxy.html" title="interface in org.apache.openjpa.util">LRSProxy</a>, <a href="../../../../org/apache/openjpa/util/ProxyBean.html" title="interface in org.apache.openjpa.util">ProxyBean</a>, <a href="../../../../org/apache/openjpa/util/ProxyCalendar.html" title="interface in org.apache.openjpa.util">ProxyCalendar</a>, <a href="../../../../org/apache/openjpa/util/ProxyCollection.html" title="interface in org.apache.openjpa.util">ProxyCollection</a>, <a href="../../../../org/apache/openjpa/util/ProxyDate.html" title="interface in org.apache.openjpa.util">ProxyDate</a>, <a href="../../../../org/apache/openjpa/util/ProxyMap.html" title="interface in org.apache.openjpa.util">ProxyMap</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/util/AbstractLRSProxyCollection.html" title="class in org.apache.openjpa.util">AbstractLRSProxyCollection</a>, <a href="../../../../org/apache/openjpa/util/AbstractLRSProxyMap.html" title="class in org.apache.openjpa.util">AbstractLRSProxyMap</a>, <a href="../../../../org/apache/openjpa/util/DelayedArrayListProxy.html" title="class in org.apache.openjpa.util">DelayedArrayListProxy</a>, <a href="../../../../org/apache/openjpa/util/DelayedHashSetProxy.html" title="class in org.apache.openjpa.util">DelayedHashSetProxy</a>, <a href="../../../../org/apache/openjpa/util/DelayedLinkedHashSetProxy.html" title="class in org.apache.openjpa.util">DelayedLinkedHashSetProxy</a>, <a href="../../../../org/apache/openjpa/util/DelayedLinkedListProxy.html" title="class in org.apache.openjpa.util">DelayedLinkedListProxy</a>, <a href="../../../../org/apache/openjpa/util/DelayedPriorityQueueProxy.html" title="class in org.apache.openjpa.util">DelayedPriorityQueueProxy</a>, <a href="../../../../org/apache/openjpa/util/DelayedTreeSetProxy.html" title="class in org.apache.openjpa.util">DelayedTreeSetProxy</a>, <a href="../../../../org/apache/openjpa/util/DelayedVectorProxy.html" title="class in org.apache.openjpa.util">DelayedVectorProxy</a>, <a href="../../../../org/apache/openjpa/jdbc/meta/strats/LRSProxyCollection.html" title="class in org.apache.openjpa.jdbc.meta.strats">LRSProxyCollection</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Proxy</span></pre>
<div class="block">Interface implemented by all proxy types to allow setting and nulling
of their owning instance.
All concrete proxy classes should be public and have publc no-args
constructors so that tools that work via reflection on persistent instances
can manipulate them.</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><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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/Proxy.html#copy(java.lang.Object)">copy</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;orig)</code>
<div class="block">Return an unproxied copy of the given instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/util/ChangeTracker.html" title="interface in org.apache.openjpa.util">ChangeTracker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/Proxy.html#getChangeTracker()">getChangeTracker</a></strong>()</code>
<div class="block">Return the change tracker for this proxy, or null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/Proxy.html#getOwner()">getOwner</a></strong>()</code>
<div class="block">Return the owning object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/Proxy.html#getOwnerField()">getOwnerField</a></strong>()</code>
<div class="block">Return the owning field index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/Proxy.html#setOwner(org.apache.openjpa.kernel.OpenJPAStateManager,%20int)">setOwner</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;field)</code>
<div class="block">Reset the state of the proxy, and set the owning instance of the
proxy and the name of the field it is assigned to.</div>
</td>
</tr>
</table>
</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="setOwner(org.apache.openjpa.kernel.OpenJPAStateManager, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOwner</h4>
<pre>void&nbsp;setOwner(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;field)</pre>
<div class="block">Reset the state of the proxy, and set the owning instance of the
proxy and the name of the field it is assigned to. Set to null to
indicate that the proxy is no longer managed.</div>
</li>
</ul>
<a name="getOwner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwner</h4>
<pre><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;getOwner()</pre>
<div class="block">Return the owning object.</div>
</li>
</ul>
<a name="getOwnerField()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnerField</h4>
<pre>int&nbsp;getOwnerField()</pre>
<div class="block">Return the owning field index.</div>
</li>
</ul>
<a name="getChangeTracker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChangeTracker</h4>
<pre><a href="../../../../org/apache/openjpa/util/ChangeTracker.html" title="interface in org.apache.openjpa.util">ChangeTracker</a>&nbsp;getChangeTracker()</pre>
<div class="block">Return the change tracker for this proxy, or null if none.</div>
</li>
</ul>
<a name="copy(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copy</h4>
<pre><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;copy(<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;orig)</pre>
<div class="block">Return an unproxied copy of the given instance. This method is used
by proxy managers to create backup values for use in rollback.</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/Proxy.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/Proxies.html" title="class in org.apache.openjpa.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/util/ProxyBean.html" title="interface 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/Proxy.html" target="_top">Frames</a></li>
<li><a href="Proxy.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>