| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.openjpa.enhance (OpenJPA Parent POM 4.1.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.openjpa.enhance (OpenJPA Parent POM 4.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.openjpa.enhance</h1> |
| </div> |
| <div class="contentContainer"> |
| <section><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block"><p><strong>OpenJPA Enhancer</strong></p> |
| |
| <p> |
| This package provides a bytecode enhancer used to |
| post-process classes for use in a OpenJPA runtime. |
| A tool for generating application identity class sourcecode is also |
| provided. |
| </p></div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ApplicationIdTool.ObjectIdLoader.html" title="interface in org.apache.openjpa.enhance">ApplicationIdTool.ObjectIdLoader</a></th> |
| <td class="colLast"> |
| <div class="block">Interface implemented by metadata factories that can load non-existant |
| object id classes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AttributeTranslator.html" title="interface in org.apache.openjpa.enhance">AttributeTranslator</a></th> |
| <td class="colLast"> |
| <div class="block">Instances of this interface can convert a positional index for a |
| <a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a> that uses property access into the underlying |
| field name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DynamicPersistenceCapable.html" title="interface in org.apache.openjpa.enhance">DynamicPersistenceCapable</a></th> |
| <td class="colLast"> |
| <div class="block">Instances that implement this marker interface are dynamically-generated |
| subtypes of managed types that were loaded before being enhanced.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DynamicStorage.html" title="interface in org.apache.openjpa.enhance">DynamicStorage</a></th> |
| <td class="colLast"> |
| <div class="block">Interface for dynamically generated classes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="FieldConsumer.html" title="interface in org.apache.openjpa.enhance">FieldConsumer</a></th> |
| <td class="colLast"> |
| <div class="block">Consumes persistent field values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="FieldManager.html" title="interface in org.apache.openjpa.enhance">FieldManager</a></th> |
| <td class="colLast"> |
| <div class="block">Manages persistent fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a></th> |
| <td class="colLast"> |
| <div class="block">Supplies persistent field values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ManagedInstanceProvider.html" title="interface in org.apache.openjpa.enhance">ManagedInstanceProvider</a></th> |
| <td class="colLast"> |
| <div class="block">Instances of this interface can provide an underlying instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PCDataGenerator.DynamicPCData.html" title="interface in org.apache.openjpa.enhance">PCDataGenerator.DynamicPCData</a></th> |
| <td class="colLast"> |
| <div class="block">Dynamic <a href="../kernel/PCData.html" title="interface in org.apache.openjpa.kernel"><code>PCData</code></a>s generated will implement this interface |
| to simplify initialization.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PCEnhancer.AuxiliaryEnhancer.html" title="interface in org.apache.openjpa.enhance">PCEnhancer.AuxiliaryEnhancer</a></th> |
| <td class="colLast"> |
| <div class="block">Plugin interface for additional enhancement.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PCRegistry.RegisterClassListener.html" title="interface in org.apache.openjpa.enhance">PCRegistry.RegisterClassListener</a></th> |
| <td class="colLast"> |
| <div class="block">Listener for persistent class registration events.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a></th> |
| <td class="colLast"> |
| <div class="block">The interface that persistent instances will implement.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RuntimeUnenhancedClassesModes.html" title="interface in org.apache.openjpa.enhance">RuntimeUnenhancedClassesModes</a></th> |
| <td class="colLast"> |
| <div class="block">Possible values for the <code>openjpa.RuntimeUnenhancedClasses</code> |
| configuration setting.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></th> |
| <td class="colLast"> |
| <div class="block">Internal state manager for managed instances.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ApplicationIdTool.html" title="class in org.apache.openjpa.enhance">ApplicationIdTool</a></th> |
| <td class="colLast"> |
| <div class="block">Generates a class appropriate for use as an application identity class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ApplicationIdTool.Flags.html" title="class in org.apache.openjpa.enhance">ApplicationIdTool.Flags</a></th> |
| <td class="colLast"> |
| <div class="block">Run flags.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ClassRedefiner.html" title="class in org.apache.openjpa.enhance">ClassRedefiner</a></th> |
| <td class="colLast"> |
| <div class="block">Redefines the method bodies of existing classes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CodeGenerator.html" title="class in org.apache.openjpa.enhance">CodeGenerator</a></th> |
| <td class="colLast"> |
| <div class="block">Generates Java class code from metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DynamicStorageGenerator.html" title="class in org.apache.openjpa.enhance">DynamicStorageGenerator</a></th> |
| <td class="colLast"> |
| <div class="block">Factory for creating new <a href="DynamicStorage.html" title="interface in org.apache.openjpa.enhance"><code>DynamicStorage</code></a> classes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="InstrumentationFactory.html" title="class in org.apache.openjpa.enhance">InstrumentationFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory for obtaining an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.instrument/java/lang/instrument/Instrumentation.html?is-external=true" title="class or interface in java.lang.instrument" class="externalLink"><code>Instrumentation</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ManagedClassSubclasser.html" title="class in org.apache.openjpa.enhance">ManagedClassSubclasser</a></th> |
| <td class="colLast"> |
| <div class="block">Redefines the method bodies of existing unenhanced classes to make them |
| notify state managers of mutations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PCClassFileTransformer.html" title="class in org.apache.openjpa.enhance">PCClassFileTransformer</a></th> |
| <td class="colLast"> |
| <div class="block">Transformer that makes persistent classes implement the |
| <a href="PersistenceCapable.html" title="interface in org.apache.openjpa.enhance"><code>PersistenceCapable</code></a> interface at runtime.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PCClassFileTransformer.Reentrant.html" title="class in org.apache.openjpa.enhance">PCClassFileTransformer.Reentrant</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PCDataGenerator.html" title="class in org.apache.openjpa.enhance">PCDataGenerator</a></th> |
| <td class="colLast"> |
| <div class="block">Generates <a href="../kernel/PCData.html" title="interface in org.apache.openjpa.kernel"><code>PCData</code></a> instances which avoid primitive wrappers |
| to optimize memory use and performance at the cost of slightly higher |
| startup time.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PCEnhancer.html" title="class in org.apache.openjpa.enhance">PCEnhancer</a></th> |
| <td class="colLast"> |
| <div class="block">Bytecode enhancer used to enhance persistent classes from metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PCEnhancer.Flags.html" title="class in org.apache.openjpa.enhance">PCEnhancer.Flags</a></th> |
| <td class="colLast"> |
| <div class="block">Run flags.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PCEnhancerAgent.html" title="class in org.apache.openjpa.enhance">PCEnhancerAgent</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| Java agent that makes persistent classes work with OpenJPA at runtime.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PCRegistry.html" title="class in org.apache.openjpa.enhance">PCRegistry</a></th> |
| <td class="colLast"> |
| <div class="block">Tracks registered persistence-capable classes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PCSubclassValidator.html" title="class in org.apache.openjpa.enhance">PCSubclassValidator</a></th> |
| <td class="colLast"> |
| <div class="block">Validates that a given type meets the JPA contract, plus a few |
| OpenJPA-specific additions for subclassing / redefinition: |
| |
| |
| must have an accessible no-args constructor |
| must be a public or protected class |
| must not be final |
| must not extend an enhanced class |
| all persistent data represented by accessible setter/getter |
| methods (persistent properties) |
| if versioning is to be used, exactly one persistent property for |
| the numeric version data <!-- ##### is this true? --> |
| |
| When using property access, the backing field for a persistent |
| property must be: |
| |
| <!-- ##### JPA validation of these needs to be tested --> |
| private |
| set only in the designated setter, |
| in the constructor, or in <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink"><code>Object.clone()</code></a>, |
| <code>readObject(ObjectInputStream)</code>, or |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Externalizable.html?is-external=true#readExternal(java.io.ObjectInput)" title="class or interface in java.io" class="externalLink"><code>Externalizable.readExternal(ObjectInput)</code></a>. |
| read only in the designated getter and the |
| constructor. |
| |
| |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RedefinitionHelper.html" title="class in org.apache.openjpa.enhance">RedefinitionHelper</a></th> |
| <td class="colLast"> |
| <div class="block">Helper methods for managed types that use method redefinition for field |
| tracking.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ReflectingPersistenceCapable.html" title="class in org.apache.openjpa.enhance">ReflectingPersistenceCapable</a></th> |
| <td class="colLast"> |
| <div class="block">Implementation of the <a href="PersistenceCapable.html" title="interface in org.apache.openjpa.enhance"><code>PersistenceCapable</code></a> interface that can handle |
| the persistence-capable contract for instances that were not enhanced |
| before class load time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Reflection.html" title="class in org.apache.openjpa.enhance">Reflection</a></th> |
| <td class="colLast"> |
| <div class="block">Reflection utilities used to support and augment enhancement.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
