blob: 0199ddfa777ef7fa78176776cd33bc1b05216fdc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:41 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LifecycleMetaData (OpenJPA Parent POM 2.4.1 API)</title>
<meta name="date" content="2016-03-21">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LifecycleMetaData (OpenJPA Parent POM 2.4.1 API)";
}
//-->
</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/LifecycleMetaData.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/meta/JavaTypes.html" title="class in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/LifecycleMetaData.html" target="_top">Frames</a></li>
<li><a href="LifecycleMetaData.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.meta</div>
<h2 title="Class LifecycleMetaData" class="title">Class LifecycleMetaData</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/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.apache.openjpa.meta.LifecycleMetaData</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">LifecycleMetaData</span>
extends <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>
implements <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Information about lifecycle events for a managed type.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Steve Kim, Abe White</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.openjpa.meta.LifecycleMetaData">Serialized Form</a></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="overviewSummary" 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>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#IGNORE_HIGH">IGNORE_HIGH</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#IGNORE_LOW">IGNORE_LOW</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#IGNORE_NONE">IGNORE_NONE</a></strong></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="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="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#getCallbacks(int)">getCallbacks</a></strong>(int&nbsp;eventType)</code>
<div class="block">Return all callbacks for the given event type, including superclass
callbacks if appropriate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#getDeclaredCallbacks(int)">getDeclaredCallbacks</a></strong>(int&nbsp;eventType)</code>
<div class="block">Return the declared callbacks for the given event type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#getIgnoreSuperclassCallbacks()">getIgnoreSuperclassCallbacks</a></strong>()</code>
<div class="block">Whether to exclude superclass callbacks from events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#getIgnoreSystemListeners()">getIgnoreSystemListeners</a></strong>()</code>
<div class="block">Whether to exclude system listeners from events.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#getNonPCSuperclassCallbacks(int)">getNonPCSuperclassCallbacks</a></strong>(int&nbsp;eventType)</code>
<div class="block">Return the callbacks for the non-PC superclass.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#is_activated()">is_activated</a></strong>()</code>
<div class="block">Whether the LifeCycleMetaData has had any callbacks or listeners registered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#setDeclaredCallbacks(int,%20org.apache.openjpa.event.LifecycleCallbacks[],%20int)">setDeclaredCallbacks</a></strong>(int&nbsp;eventType,
<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;callbacks,
int&nbsp;highPriority)</code>
<div class="block">Set the callbacks for the given event type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#setIgnoreSuperclassCallbacks(int)">setIgnoreSuperclassCallbacks</a></strong>(int&nbsp;ignore)</code>
<div class="block">Whether to exclude superclass callbacks from events.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#setIgnoreSystemListeners(boolean)">setIgnoreSystemListeners</a></strong>(boolean&nbsp;ignore)</code>
<div class="block">Whether to exclude system listeners from events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html#setNonPCSuperclassCallbacks(int,%20org.apache.openjpa.event.LifecycleCallbacks[],%20int)">setNonPCSuperclassCallbacks</a></strong>(int&nbsp;eventType,
<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;callbacks,
int&nbsp;highPriority)</code>
<div class="block">Set the callbacks for the given event type for non-persistent
superclass.</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="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="IGNORE_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IGNORE_NONE</h4>
<pre>public static final&nbsp;int IGNORE_NONE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.LifecycleMetaData.IGNORE_NONE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="IGNORE_HIGH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IGNORE_HIGH</h4>
<pre>public static final&nbsp;int IGNORE_HIGH</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.LifecycleMetaData.IGNORE_HIGH">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="IGNORE_LOW">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IGNORE_LOW</h4>
<pre>public static final&nbsp;int IGNORE_LOW</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.LifecycleMetaData.IGNORE_LOW">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="is_activated()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>is_activated</h4>
<pre>public&nbsp;boolean&nbsp;is_activated()</pre>
<div class="block">Whether the LifeCycleMetaData has had any callbacks or listeners registered. Used
for a quick test to determine whether to attempt to fire any events.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl>
</li>
</ul>
<a name="getIgnoreSystemListeners()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreSystemListeners</h4>
<pre>public&nbsp;boolean&nbsp;getIgnoreSystemListeners()</pre>
<div class="block">Whether to exclude system listeners from events.</div>
</li>
</ul>
<a name="setIgnoreSystemListeners(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreSystemListeners</h4>
<pre>public&nbsp;void&nbsp;setIgnoreSystemListeners(boolean&nbsp;ignore)</pre>
<div class="block">Whether to exclude system listeners from events.</div>
</li>
</ul>
<a name="getIgnoreSuperclassCallbacks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreSuperclassCallbacks</h4>
<pre>public&nbsp;int&nbsp;getIgnoreSuperclassCallbacks()</pre>
<div class="block">Whether to exclude superclass callbacks from events.</div>
</li>
</ul>
<a name="setIgnoreSuperclassCallbacks(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreSuperclassCallbacks</h4>
<pre>public&nbsp;void&nbsp;setIgnoreSuperclassCallbacks(int&nbsp;ignore)</pre>
<div class="block">Whether to exclude superclass callbacks from events.</div>
</li>
</ul>
<a name="getDeclaredCallbacks(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredCallbacks</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;getDeclaredCallbacks(int&nbsp;eventType)</pre>
<div class="block">Return the declared callbacks for the given event type.</div>
</li>
</ul>
<a name="getCallbacks(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCallbacks</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;getCallbacks(int&nbsp;eventType)</pre>
<div class="block">Return all callbacks for the given event type, including superclass
callbacks if appropriate.</div>
</li>
</ul>
<a name="setDeclaredCallbacks(int, org.apache.openjpa.event.LifecycleCallbacks[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeclaredCallbacks</h4>
<pre>public&nbsp;void&nbsp;setDeclaredCallbacks(int&nbsp;eventType,
<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;callbacks,
int&nbsp;highPriority)</pre>
<div class="block">Set the callbacks for the given event type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>highPriority</code> - the first N given callbacks are high priority;
high priority callbacks will be returned before
non-high-priority superclass callbacks</dd></dl>
</li>
</ul>
<a name="getNonPCSuperclassCallbacks(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNonPCSuperclassCallbacks</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;getNonPCSuperclassCallbacks(int&nbsp;eventType)</pre>
<div class="block">Return the callbacks for the non-PC superclass.</div>
</li>
</ul>
<a name="setNonPCSuperclassCallbacks(int, org.apache.openjpa.event.LifecycleCallbacks[], int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setNonPCSuperclassCallbacks</h4>
<pre>public&nbsp;void&nbsp;setNonPCSuperclassCallbacks(int&nbsp;eventType,
<a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a>[]&nbsp;callbacks,
int&nbsp;highPriority)</pre>
<div class="block">Set the callbacks for the given event type for non-persistent
superclass. Note these callbacks will only be used where the
non-persistent superclass is the direct ancestor of the described class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>highPriority</code> - the first N given callbacks are high priority;
high priority callbacks will be returned before
non-high-priority superclass callbacks</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><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/LifecycleMetaData.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/meta/JavaTypes.html" title="class in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/meta/LifecycleMetaData.html" target="_top">Frames</a></li>
<li><a href="LifecycleMetaData.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>