| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JDOEnhancer (JDO API 3.2.1)</title> |
| <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="JDOEnhancer (JDO API 3.2.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/JDOEnhancer.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="../../javax/jdo/JDOEnhanceException.html" title="class in javax.jdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jdo/JDOException.html" title="class in javax.jdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jdo/JDOEnhancer.html" target="_top">Frames</a></li> |
| <li><a href="JDOEnhancer.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">javax.jdo</div> |
| <h2 title="Interface JDOEnhancer" class="title">Interface JDOEnhancer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JDOEnhancer</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a></pre> |
| <div class="block">Interface for a JDO Enhancer.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#addClass-java.lang.String-byte:A-">addClass</a></span>(<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> className, |
| byte[] bytes)</code> |
| <div class="block">Add an in-memory class to the items to be enhanced.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#addClasses-java.lang.String...-">addClasses</a></span>(<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>... classNames)</code> |
| <div class="block">Add class(es) to the items to be enhanced.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#addFiles-java.lang.String...-">addFiles</a></span>(<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>... metadataFiles)</code> |
| <div class="block">Add metadata file(s) to the items to be enhanced.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#addJar-java.lang.String-">addJar</a></span>(<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> jarFileName)</code> |
| <div class="block">Add a jar file to the items to be enhanced.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#addPersistenceUnit-java.lang.String-">addPersistenceUnit</a></span>(<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> persistenceUnit)</code> |
| <div class="block">Add a persistence-unit to the items to be enhanced.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#enhance--">enhance</a></span>()</code> |
| <div class="block">Method to enhance the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#getEnhancedBytes-java.lang.String-">getEnhancedBytes</a></span>(<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> className)</code> |
| <div class="block">Method to retrieve the (enhanced) bytes of the specified class.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">Return non-configurable properties of this JDOEnhancer.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#newMetadata--">newMetadata</a></span>()</code> |
| <div class="block">Method to return a new metadata object that can be subsequently modified |
| and registered with the enhancement process using the method <a href="../../javax/jdo/JDOEnhancer.html#registerMetadata-javax.jdo.metadata.JDOMetadata-"><code>registerMetadata(javax.jdo.metadata.JDOMetadata)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#registerMetadata-javax.jdo.metadata.JDOMetadata-">registerMetadata</a></span>(<a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a> metadata)</code> |
| <div class="block">Method to register metadata with the enhancement process managed by this |
| <code>JDOEnhancer</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#setClassLoader-java.lang.ClassLoader-">setClassLoader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">Mutator to set the class loader to use for loading classes.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#setOutputDirectory-java.lang.String-">setOutputDirectory</a></span>(<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> dirName)</code> |
| <div class="block">Mutator to set the location where enhanced classes are written.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#setVerbose-boolean-">setVerbose</a></span>(boolean flag)</code> |
| <div class="block">Whether to provide verbose output</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/JDOEnhancer.html#validate--">validate</a></span>()</code> |
| <div class="block">Method to validate the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.instrument.ClassFileTransformer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.instrument.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true#transform-java.lang.ClassLoader-java.lang.String-java.lang.Class-java.security.ProtectionDomain-byte:A-" title="class or interface in java.lang.instrument">transform</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="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getProperties()</pre> |
| <div class="block">Return non-configurable properties of this JDOEnhancer. |
| Properties with keys "VendorName" and "VersionNumber" are required. |
| Other keys are optional.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the non-configurable properties of this JDOEnhancer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVerbose-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVerbose</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> setVerbose(boolean flag)</pre> |
| <div class="block">Whether to provide verbose output</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - Verbose?</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOutputDirectory-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputDirectory</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> setOutputDirectory(<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> dirName)</pre> |
| <div class="block">Mutator to set the location where enhanced classes are written. |
| Mutator to set the location where enhanced classes are written. |
| If this method is not called, classes will be enhanced in place, |
| overwriting the existing classes. If overwriting classes in a jar file, |
| the existing files in the jar file will be written unchanged except |
| for the enhanced classes. The directory name can be absolute or relative.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dirName</code> - Name of the directory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setClassLoader-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClassLoader</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> setClassLoader(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</pre> |
| <div class="block">Mutator to set the class loader to use for loading classes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loader</code> - ClassLoader to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPersistenceUnit-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPersistenceUnit</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> addPersistenceUnit(<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> persistenceUnit)</pre> |
| <div class="block">Add a persistence-unit to the items to be enhanced.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>persistenceUnit</code> - Name of the persistence unit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addClass-java.lang.String-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addClass</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> addClass(<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> className, |
| byte[] bytes)</pre> |
| <div class="block">Add an in-memory class to the items to be enhanced. |
| The class name should be of the form "mydomain.MyClass".</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>className</code> - Name of the class</dd> |
| <dd><code>bytes</code> - The bytes of the class</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addClasses-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addClasses</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> addClasses(<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>... classNames)</pre> |
| <div class="block">Add class(es) to the items to be enhanced. |
| The class names can be absolute file names, relative file names, or |
| names of CLASSPATH resources.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classNames</code> - Names of the classes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFiles-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFiles</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> addFiles(<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>... metadataFiles)</pre> |
| <div class="block">Add metadata file(s) to the items to be enhanced. |
| The metadata file names can be absolute file names, relative file names, or |
| names of CLASSPATH resources. They should be JDO XML metadata files.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadataFiles</code> - Names of the files</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addJar-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addJar</h4> |
| <pre><a href="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</a> addJar(<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> jarFileName)</pre> |
| <div class="block">Add a jar file to the items to be enhanced. |
| The jar file name can be absolute, or relative or a CLASSPATH resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jarFileName</code> - Name of the jar file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The enhancer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enhance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enhance</h4> |
| <pre>int enhance()</pre> |
| <div class="block">Method to enhance the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of classes enhanced</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOEnhanceException.html" title="class in javax.jdo">JDOEnhanceException</a></code> - if an error occurs during enhancement. If multiple |
| errors occur then the nested exceptions provides this detail.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>int validate()</pre> |
| <div class="block">Method to validate the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of classes validated</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/jdo/JDOEnhanceException.html" title="class in javax.jdo">JDOEnhanceException</a></code> - if an error occurs during validation. If multiple |
| errors occur then the nested exceptions provides this detail.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnhancedBytes-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnhancedBytes</h4> |
| <pre>byte[] getEnhancedBytes(<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> className)</pre> |
| <div class="block">Method to retrieve the (enhanced) bytes of the specified class. |
| Only applies to the classes enhanced in the most recent enhance() call. |
| If no enhance has yet been performed will throw a JDOEnhanceException. |
| If the specified class hasn't been enhanced then will throw a JDOEnhanceException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>className</code> - Name of the class (of the form "mydomain.MyClass")</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Enhanced bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerMetadata-javax.jdo.metadata.JDOMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMetadata</h4> |
| <pre>void registerMetadata(<a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a> metadata)</pre> |
| <div class="block">Method to register metadata with the enhancement process managed by this |
| <code>JDOEnhancer</code>. |
| Metadata can be created using the method <a href="../../javax/jdo/JDOEnhancer.html#newMetadata--"><code>newMetadata()</code></a>. |
| If there is already metadata registered for a class contained in this metadata |
| object then a JDOUserException will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - The Metadata to register.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newMetadata</h4> |
| <pre><a href="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</a> newMetadata()</pre> |
| <div class="block">Method to return a new metadata object that can be subsequently modified |
| and registered with the enhancement process using the method <a href="../../javax/jdo/JDOEnhancer.html#registerMetadata-javax.jdo.metadata.JDOMetadata-"><code>registerMetadata(javax.jdo.metadata.JDOMetadata)</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The metadata</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</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="class-use/JDOEnhancer.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="../../javax/jdo/JDOEnhanceException.html" title="class in javax.jdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/jdo/JDOException.html" title="class in javax.jdo"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/jdo/JDOEnhancer.html" target="_top">Frames</a></li> |
| <li><a href="JDOEnhancer.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2005–2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
