| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_25) on Sun Sep 22 17:57:48 MST 2013 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| JDOEnhancer (JDO API null) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2013-09-22"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JDOEnhancer (JDO API null)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDOEnhancer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/jdo/JDOEnhanceException.html" title="class in javax.jdo"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/jdo/JDOException.html" title="class in javax.jdo"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/jdo/JDOEnhancer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JDOEnhancer.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| javax.jdo</FONT> |
| <BR> |
| Interface JDOEnhancer</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>JDOEnhancer</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</A></DL> |
| </PRE> |
| |
| <P> |
| Interface for a JDO Enhancer. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#addClass(java.lang.String, byte[])">addClass</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, |
| byte[] bytes)</CODE> |
| |
| <BR> |
| Add an in-memory class to the items to be enhanced.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#addClasses(java.lang.String...)">addClasses</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... classNames)</CODE> |
| |
| <BR> |
| Add class(es) to the items to be enhanced.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#addFiles(java.lang.String...)">addFiles</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... metadataFiles)</CODE> |
| |
| <BR> |
| Add metadata file(s) to the items to be enhanced.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#addJar(java.lang.String)">addJar</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jarFileName)</CODE> |
| |
| <BR> |
| Add a jar file to the items to be enhanced.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#addPersistenceUnit(java.lang.String)">addPersistenceUnit</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> persistenceUnit)</CODE> |
| |
| <BR> |
| Add a persistence-unit to the items to be enhanced.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#enhance()">enhance</A></B>()</CODE> |
| |
| <BR> |
| Method to enhance the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#getEnhancedBytes(java.lang.String)">getEnhancedBytes</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className)</CODE> |
| |
| <BR> |
| Method to retrieve the (enhanced) bytes of the specified class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#getProperties()">getProperties</A></B>()</CODE> |
| |
| <BR> |
| Return non-configurable properties of this JDOEnhancer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#newMetadata()">newMetadata</A></B>()</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#registerMetadata(javax.jdo.metadata.JDOMetadata)">registerMetadata</A></B>(<A HREF="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</A> metadata)</CODE> |
| |
| <BR> |
| Method to register metadata with the enhancement process managed by this |
| <code>JDOEnhancer</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#setClassLoader(java.lang.ClassLoader)">setClassLoader</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</A> loader)</CODE> |
| |
| <BR> |
| Mutator to set the class loader to use for loading classes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#setOutputDirectory(java.lang.String)">setOutputDirectory</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> dirName)</CODE> |
| |
| <BR> |
| Mutator to set the location where enhanced classes are written.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#setVerbose(boolean)">setVerbose</A></B>(boolean flag)</CODE> |
| |
| <BR> |
| Whether to provide verbose output</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../javax/jdo/JDOEnhancer.html#validate()">validate</A></B>()</CODE> |
| |
| <BR> |
| Method to validate the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.instrument.ClassFileTransformer"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface java.lang.instrument.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true" title="class or interface in java.lang.instrument">ClassFileTransformer</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/instrument/ClassFileTransformer.html?is-external=true#transform(java.lang.ClassLoader, java.lang.String, java.lang.Class, java.security.ProtectionDomain, byte[])" title="class or interface in java.lang.instrument">transform</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getProperties()"><!-- --></A><H3> |
| getProperties</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> <B>getProperties</B>()</PRE> |
| <DL> |
| <DD>Return non-configurable properties of this JDOEnhancer. |
| Properties with keys "VendorName" and "VersionNumber" are required. |
| Other keys are optional. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the non-configurable properties of this JDOEnhancer.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVerbose(boolean)"><!-- --></A><H3> |
| setVerbose</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>setVerbose</B>(boolean flag)</PRE> |
| <DL> |
| <DD>Whether to provide verbose output |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>flag</CODE> - Verbose? |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOutputDirectory(java.lang.String)"><!-- --></A><H3> |
| setOutputDirectory</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>setOutputDirectory</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> dirName)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dirName</CODE> - Name of the directory |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setClassLoader(java.lang.ClassLoader)"><!-- --></A><H3> |
| setClassLoader</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>setClassLoader</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</A> loader)</PRE> |
| <DL> |
| <DD>Mutator to set the class loader to use for loading classes. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>loader</CODE> - ClassLoader to use |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPersistenceUnit(java.lang.String)"><!-- --></A><H3> |
| addPersistenceUnit</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>addPersistenceUnit</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> persistenceUnit)</PRE> |
| <DL> |
| <DD>Add a persistence-unit to the items to be enhanced. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>persistenceUnit</CODE> - Name of the persistence unit |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addClass(java.lang.String, byte[])"><!-- --></A><H3> |
| addClass</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>addClass</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, |
| byte[] bytes)</PRE> |
| <DL> |
| <DD>Add an in-memory class to the items to be enhanced. |
| The class name should be of the form "mydomain.MyClass". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>className</CODE> - Name of the class<DD><CODE>bytes</CODE> - The bytes of the class |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addClasses(java.lang.String...)"><!-- --></A><H3> |
| addClasses</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>addClasses</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... classNames)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>classNames</CODE> - Names of the classes |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFiles(java.lang.String...)"><!-- --></A><H3> |
| addFiles</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>addFiles</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... metadataFiles)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>metadataFiles</CODE> - Names of the files |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addJar(java.lang.String)"><!-- --></A><H3> |
| addJar</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/JDOEnhancer.html" title="interface in javax.jdo">JDOEnhancer</A> <B>addJar</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jarFileName)</PRE> |
| <DL> |
| <DD>Add a jar file to the items to be enhanced. |
| The jar file name can be absolute, or relative or a CLASSPATH resource. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>jarFileName</CODE> - Name of the jar file |
| <DT><B>Returns:</B><DD>The enhancer</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="enhance()"><!-- --></A><H3> |
| enhance</H3> |
| <PRE> |
| int <B>enhance</B>()</PRE> |
| <DL> |
| <DD>Method to enhance the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Number of classes enhanced |
| <DT><B>Throws:</B> |
| <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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="validate()"><!-- --></A><H3> |
| validate</H3> |
| <PRE> |
| int <B>validate</B>()</PRE> |
| <DL> |
| <DD>Method to validate the items specified using addJar, addFiles, addClasses, addClass, |
| addPersistenceUnit. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Number of classes validated |
| <DT><B>Throws:</B> |
| <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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEnhancedBytes(java.lang.String)"><!-- --></A><H3> |
| getEnhancedBytes</H3> |
| <PRE> |
| byte[] <B>getEnhancedBytes</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>className</CODE> - Name of the class (of the form "mydomain.MyClass") |
| <DT><B>Returns:</B><DD>Enhanced bytes</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="registerMetadata(javax.jdo.metadata.JDOMetadata)"><!-- --></A><H3> |
| registerMetadata</H3> |
| <PRE> |
| void <B>registerMetadata</B>(<A HREF="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</A> metadata)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>metadata</CODE> - The Metadata to register.<DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newMetadata()"><!-- --></A><H3> |
| newMetadata</H3> |
| <PRE> |
| <A HREF="../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata">JDOMetadata</A> <B>newMetadata</B>()</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The metadata<DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JDOEnhancer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../javax/jdo/JDOEnhanceException.html" title="class in javax.jdo"><B>PREV CLASS</B></A> |
| <A HREF="../../javax/jdo/JDOException.html" title="class in javax.jdo"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../index.html?javax/jdo/JDOEnhancer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JDOEnhancer.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
