| <!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:50 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractOpenJpaMojo (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="AbstractOpenJpaMojo (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/AbstractOpenJpaMojo.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/tools/maven/AbstractOpenJpaMappingToolMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/tools/maven/HelpMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" target="_top">Frames</a></li> |
| <li><a href="AbstractOpenJpaMojo.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.tools.maven</div> |
| <h2 title="Class AbstractOpenJpaMojo" class="title">Class AbstractOpenJpaMojo</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.maven.plugin.AbstractMojo</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.tools.maven.AbstractOpenJpaMojo</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaEnhancerMojo</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMappingToolMojo</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">AbstractOpenJpaMojo</span> |
| extends org.apache.maven.plugin.AbstractMojo</pre> |
| <div class="block">Base class for OpenJPA maven tasks.</div> |
| <dl><dt><span class="strong">Version:</span></dt> |
| <dd>$Id$</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"> </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>protected <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#classes">classes</a></strong></code> |
| <div class="block">Location where <code>persistence-enabled</code> classes are located.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#compileClasspathElements">compileClasspathElements</a></strong></code> |
| <div class="block">List of all class path elements that will be searched for the |
| <code>persistence-enabled</code> classes and resources expected by |
| PCEnhancer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_DRIVER_NAME">OPTION_CONNECTION_DRIVER_NAME</a></strong></code> |
| <div class="block">the string used for passing information about the connectionDriverName</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_PROPERTIES">OPTION_CONNECTION_PROPERTIES</a></strong></code> |
| <div class="block">the string used for passing information about the connectionProperties</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES">OPTION_PROPERTIES</a></strong></code> |
| <div class="block">The properties option is used for passing information about the persistence.xml |
| classpath resource and the default unit</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES_FILE">OPTION_PROPERTIES_FILE</a></strong></code> |
| <div class="block">the properties option is used for passing information about the persistence.xml file location</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#project">project</a></strong></code> |
| <div class="block">The Maven Project Object</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#workDir">workDir</a></strong></code> |
| <div class="block">The working directory for putting persistence.xml and |
| other stuff into if we need to.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.plugin.Mojo"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3> |
| <code>ROLE</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#AbstractOpenJpaMojo()">AbstractOpenJpaMojo</a></strong>()</code> |
| <div class="block">default ct</div> |
| </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"> </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>protected <a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#createOptions()">createOptions</a></strong>()</code> |
| <div class="block">This function will usually get called by <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions()"><code>getOptions()</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#extendRealmClasspath()">extendRealmClasspath</a></strong>()</code> |
| <div class="block">This will prepare the current ClassLoader and add all jars and local |
| classpaths (e.g. target/classes) needed by the OpenJPA task.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#findEntityClassFiles()">findEntityClassFiles</a></strong>()</code> |
| <div class="block">Locates and returns a list of class files found under specified class |
| directory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getClasspathElements()">getClasspathElements</a></strong>()</code> |
| <div class="block">This function retrieves the injected classpath elements for the current mojo.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getEntityClasses()">getEntityClasses</a></strong>()</code> |
| <div class="block">The File where the class files of the entities to enhance reside</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getFilePaths(java.util.List)">getFilePaths</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> files)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions()">getOptions</a></strong>()</code> |
| <div class="block">Get the options for the various OpenJPA tools.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#skipMojo()">skipMojo</a></strong>()</code> |
| <div class="block">Determine if the mojo execution should get skipped.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> |
| <code>getLog, getPluginContext, setLog, setPluginContext</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.Mojo"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.maven.plugin.Mojo</h3> |
| <code>execute</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="workDir"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>workDir</h4> |
| <pre>@Parameter(property="openjpa.workdir", |
| defaultValue="${project.build.directory}/openjpa-work", |
| required=true) |
| protected <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workDir</pre> |
| <div class="block">The working directory for putting persistence.xml and |
| other stuff into if we need to.</div> |
| </li> |
| </ul> |
| <a name="classes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classes</h4> |
| <pre>@Parameter(property="openjpa.classes", |
| defaultValue="${project.build.outputDirectory}", |
| required=true) |
| protected <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> classes</pre> |
| <div class="block">Location where <code>persistence-enabled</code> classes are located.</div> |
| </li> |
| </ul> |
| <a name="OPTION_CONNECTION_DRIVER_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTION_CONNECTION_DRIVER_NAME</h4> |
| <pre>protected static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OPTION_CONNECTION_DRIVER_NAME</pre> |
| <div class="block">the string used for passing information about the connectionDriverName</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.tools.maven.AbstractOpenJpaMojo.OPTION_CONNECTION_DRIVER_NAME">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="OPTION_CONNECTION_PROPERTIES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTION_CONNECTION_PROPERTIES</h4> |
| <pre>protected static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OPTION_CONNECTION_PROPERTIES</pre> |
| <div class="block">the string used for passing information about the connectionProperties</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.tools.maven.AbstractOpenJpaMojo.OPTION_CONNECTION_PROPERTIES">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="compileClasspathElements"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compileClasspathElements</h4> |
| <pre>@Parameter(defaultValue="${project.compileClasspathElements}", |
| required=true, |
| readonly=true) |
| protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> compileClasspathElements</pre> |
| <div class="block">List of all class path elements that will be searched for the |
| <code>persistence-enabled</code> classes and resources expected by |
| PCEnhancer.</div> |
| </li> |
| </ul> |
| <a name="project"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>project</h4> |
| <pre>@Parameter(defaultValue="${project}", |
| required=true, |
| readonly=true) |
| protected org.apache.maven.project.MavenProject project</pre> |
| <div class="block">The Maven Project Object</div> |
| </li> |
| </ul> |
| <a name="OPTION_PROPERTIES_FILE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTION_PROPERTIES_FILE</h4> |
| <pre>protected static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OPTION_PROPERTIES_FILE</pre> |
| <div class="block">the properties option is used for passing information about the persistence.xml file location</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.tools.maven.AbstractOpenJpaMojo.OPTION_PROPERTIES_FILE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="OPTION_PROPERTIES"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OPTION_PROPERTIES</h4> |
| <pre>protected static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OPTION_PROPERTIES</pre> |
| <div class="block">The properties option is used for passing information about the persistence.xml |
| classpath resource and the default unit</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.tools.maven.AbstractOpenJpaMojo.OPTION_PROPERTIES">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractOpenJpaMojo()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractOpenJpaMojo</h4> |
| <pre>public AbstractOpenJpaMojo()</pre> |
| <div class="block">default ct</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEntityClasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityClasses</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getEntityClasses()</pre> |
| <div class="block">The File where the class files of the entities to enhance reside</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>normaly the entity classes are located in target/classes</dd></dl> |
| </li> |
| </ul> |
| <a name="getClasspathElements()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasspathElements</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getClasspathElements()</pre> |
| <div class="block">This function retrieves the injected classpath elements for the current mojo.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>List of classpath elements for the compile phase</dd></dl> |
| </li> |
| </ul> |
| <a name="getOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptions</h4> |
| <pre>protected abstract <a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a> getOptions() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <div class="block">Get the options for the various OpenJPA tools.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>populated Options</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd></dl> |
| </li> |
| </ul> |
| <a name="skipMojo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skipMojo</h4> |
| <pre>protected boolean skipMojo()</pre> |
| <div class="block"><p>Determine if the mojo execution should get skipped.</p> |
| This is the case if: |
| <ul> |
| <li><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#skip"><code>skip</code></a> is <code>true</code></li> |
| <li>if the mojo gets executed on a project with packaging type 'pom' and |
| <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#forceMojoExecution"><code>forceMojoExecution</code></a> is <code>false</code></li> |
| </ul></div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the mojo execution should be skipped.</dd></dl> |
| </li> |
| </ul> |
| <a name="createOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createOptions</h4> |
| <pre>protected <a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a> createOptions() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <div class="block">This function will usually get called by <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions()"><code>getOptions()</code></a></div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the Options filled with the initial values</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd></dl> |
| </li> |
| </ul> |
| <a name="extendRealmClasspath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extendRealmClasspath</h4> |
| <pre>protected void extendRealmClasspath() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <div class="block">This will prepare the current ClassLoader and add all jars and local |
| classpaths (e.g. target/classes) needed by the OpenJPA task.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code> - on any error inside the mojo</dd></dl> |
| </li> |
| </ul> |
| <a name="findEntityClassFiles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findEntityClassFiles</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> findEntityClassFiles() |
| throws org.apache.maven.plugin.MojoExecutionException</pre> |
| <div class="block">Locates and returns a list of class files found under specified class |
| directory.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>list of class files.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if there was an error scanning class file |
| resources.</dd></dl> |
| </li> |
| </ul> |
| <a name="getFilePaths(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFilePaths</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getFilePaths(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> files)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>files</code> - List of files</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the paths of the given files as String[]</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/AbstractOpenJpaMojo.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/tools/maven/AbstractOpenJpaMappingToolMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/tools/maven/HelpMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" target="_top">Frames</a></li> |
| <li><a href="AbstractOpenJpaMojo.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
