Added: websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html ============================================================================== --- websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html (added) +++ websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html Sun Sep 6 20:16:19 2020 @@ -0,0 +1,439 @@ +<!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 (1.8.0_252) on Sun Sep 06 22:02:04 CEST 2020 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractOpenJpaEnhancerMojo (OpenJPA Maven Plugin 3.1.3-SNAPSHOT API)</title> +<meta name="date" content="2020-09-06"> +<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="AbstractOpenJpaEnhancerMojo (OpenJPA Maven Plugin 3.1.3-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../org/apache/openjpa/tools/maven/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractOpenJpaEnhancerMojo.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>Prev Class</li> +<li><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractOpenJpaEnhancerMojo.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 AbstractOpenJpaEnhancerMojo" class="title">Class AbstractOpenJpaEnhancerMojo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/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><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">org.apache.openjpa.tools.maven.AbstractOpenJpaMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.openjpa.tools.maven.AbstractOpenJpaEnhancerMojo</li> +</ul> +</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/OpenJpaEnhancerMojo.html" title="class in org.apache.openjpa.tools.maven">OpenJpaEnhancerMojo</a>, <a href="../../../../../org/apache/openjpa/tools/maven/OpenJpaTestEnhancerMojo.html" title="class in org.apache.openjpa.tools.maven">OpenJpaTestEnhancerMojo</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">AbstractOpenJpaEnhancerMojo</span> +extends <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></pre> +<div class="block">The base class for all enhancement mojos.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.1</dd> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>$Id: AbstractOpenJpaTestEnhancerMojo.java 9137 2009-02-28 21:55:03Z struberg $</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="memberSummary" 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 boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#addDefaultConstructor">addDefaultConstructor</a></span></code> +<div class="block">The JPA spec requires that all persistent classes define a no-arg constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#enforcePropertyRestrictions">enforcePropertyRestrictions</a></span></code> +<div class="block">Whether to throw an exception when it appears that a property access entity + is not obeying the restrictions placed on property access.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#tmpClassLoader">tmpClassLoader</a></span></code> +<div class="block">Tell the PCEnhancer to use a temporary classloader for enhancement.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.tools.maven.AbstractOpenJpaMojo"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.openjpa.tools.maven.<a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></h3> +<code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#classes">classes</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#compileClasspathElements">compileClasspathElements</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_DRIVER_NAME">OPTION_CONNECTION_DRIVER_NAME</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_PROPERTIES">OPTION_CONNECTION_PROPERTIES</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES">OPTION_PROPERTIES</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES_FILE">OPTION_PROPERTIES_FILE</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#project">project</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#workDir">workDir</a></code> </li> +</ul> +<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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#AbstractOpenJpaEnhancerMojo--">AbstractOpenJpaEnhancerMojo</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#execute--">execute</a></span>()</code></td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected org.apache.openjpa.lib.util.Options</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#getOptions--">getOptions</a></span>()</code> +<div class="block">Get the options for the OpenJPA enhancer tool.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.tools.maven.AbstractOpenJpaMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.openjpa.tools.maven.<a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></h3> +<code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#createOptions--">createOptions</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#extendRealmClasspath--">extendRealmClasspath</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#findEntityClassFiles--">findEntityClassFiles</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getClasspathElements--">getClasspathElements</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getEntityClasses--">getEntityClasses</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getFilePaths-java.util.List-">getFilePaths</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#skipMojo--">skipMojo</a></code></li> +</ul> +<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="addDefaultConstructor"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDefaultConstructor</h4> +<pre>@Parameter(defaultValue="true") +protected boolean addDefaultConstructor</pre> +<div class="block">The JPA spec requires that all persistent classes define a no-arg constructor. + This flag tells the enhancer whether to add a protected no-arg constructor + to any persistent classes that don't already have one.</div> +</li> +</ul> +<a name="enforcePropertyRestrictions"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enforcePropertyRestrictions</h4> +<pre>@Parameter(defaultValue="false") +protected boolean enforcePropertyRestrictions</pre> +<div class="block">Whether to throw an exception when it appears that a property access entity + is not obeying the restrictions placed on property access.</div> +</li> +</ul> +<a name="tmpClassLoader"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>tmpClassLoader</h4> +<pre>@Parameter(defaultValue="false") +protected boolean tmpClassLoader</pre> +<div class="block">Tell the PCEnhancer to use a temporary classloader for enhancement. + If you enable this feature, then no depending artifacts from the classpath will be used! + Please note that you have to disable the tmpClassLoader for some cases in OpenJPA-1.2.1 + due to an extended parsing strategy.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractOpenJpaEnhancerMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractOpenJpaEnhancerMojo</h4> +<pre>public AbstractOpenJpaEnhancerMojo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws org.apache.maven.plugin.MojoExecutionException, + org.apache.maven.plugin.MojoFailureException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> +<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Mojo.execute()</code></dd> +</dl> +</li> +</ul> +<a name="getOptions--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOptions</h4> +<pre>protected org.apache.openjpa.lib.util.Options getOptions() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Get the options for the OpenJPA enhancer tool.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions--">getOptions</a></code> in class <code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>populated Options</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></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="../../../../../org/apache/openjpa/tools/maven/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractOpenJpaEnhancerMojo.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>Prev Class</li> +<li><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractOpenJpaEnhancerMojo.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 © 2011–2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Propchange: websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html ============================================================================== --- websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html (added) +++ websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html Sun Sep 6 20:16:19 2020 @@ -0,0 +1,399 @@ +<!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 (1.8.0_252) on Sun Sep 06 22:02:04 CEST 2020 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractOpenJpaMappingToolMojo (OpenJPA Maven Plugin 3.1.3-SNAPSHOT API)</title> +<meta name="date" content="2020-09-06"> +<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="AbstractOpenJpaMappingToolMojo (OpenJPA Maven Plugin 3.1.3-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../org/apache/openjpa/tools/maven/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractOpenJpaMappingToolMojo.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/AbstractOpenJpaEnhancerMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractOpenJpaMappingToolMojo.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 AbstractOpenJpaMappingToolMojo" class="title">Class AbstractOpenJpaMappingToolMojo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/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><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">org.apache.openjpa.tools.maven.AbstractOpenJpaMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.openjpa.tools.maven.AbstractOpenJpaMappingToolMojo</li> +</ul> +</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/OpenJpaSchemaMojo.html" title="class in org.apache.openjpa.tools.maven">OpenJpaSchemaMojo</a>, <a href="../../../../../org/apache/openjpa/tools/maven/OpenJpaSqlMojo.html" title="class in org.apache.openjpa.tools.maven">OpenJpaSqlMojo</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">AbstractOpenJpaMappingToolMojo</span> +extends <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></pre> +<div class="block">Processes Application model classes and generate the DDL by running the + OpenJPA MappingTool. + + We have to split the generation of the SQL files and the mapping info + into 2 separate mojos, since the MappingTool struggles to generate both + in one step.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.0</dd> +<dt><span class="simpleTagLabel">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="memberSummary" 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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html#action">action</a></span></code> +<div class="block">Argument to specify the action to take on each class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html#OPTION_ACTION">OPTION_ACTION</a></span></code> +<div class="block">used for passing the action parameter to the mapping tool</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.tools.maven.AbstractOpenJpaMojo"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.openjpa.tools.maven.<a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></h3> +<code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#classes">classes</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#compileClasspathElements">compileClasspathElements</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_DRIVER_NAME">OPTION_CONNECTION_DRIVER_NAME</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_PROPERTIES">OPTION_CONNECTION_PROPERTIES</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES">OPTION_PROPERTIES</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES_FILE">OPTION_PROPERTIES_FILE</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#project">project</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#workDir">workDir</a></code> </li> +</ul> +<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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html#AbstractOpenJpaMappingToolMojo--">AbstractOpenJpaMappingToolMojo</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html#execute--">execute</a></span>()</code></td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.tools.maven.AbstractOpenJpaMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.openjpa.tools.maven.<a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven">AbstractOpenJpaMojo</a></h3> +<code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#createOptions--">createOptions</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#extendRealmClasspath--">extendRealmClasspath</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#findEntityClassFiles--">findEntityClassFiles</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getClasspathElements--">getClasspathElements</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getEntityClasses--">getEntityClasses</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getFilePaths-java.util.List-">getFilePaths</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions--">getOptions</a>, <a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#skipMojo--">skipMojo</a></code></li> +</ul> +<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="action"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>action</h4> +<pre>@Parameter +protected <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> action</pre> +<div class="block">Argument to specify the action to take on each class. The available actions are: + buildSchema, validate</div> +</li> +</ul> +<a name="OPTION_ACTION"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OPTION_ACTION</h4> +<pre>protected static final <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> OPTION_ACTION</pre> +<div class="block">used for passing the action parameter to the mapping tool</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.openjpa.tools.maven.AbstractOpenJpaMappingToolMojo.OPTION_ACTION">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="AbstractOpenJpaMappingToolMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractOpenJpaMappingToolMojo</h4> +<pre>public AbstractOpenJpaMappingToolMojo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws org.apache.maven.plugin.MojoExecutionException, + org.apache.maven.plugin.MojoFailureException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> +<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Mojo.execute()</code></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="../../../../../org/apache/openjpa/tools/maven/package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractOpenJpaMappingToolMojo.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/AbstractOpenJpaEnhancerMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html" title="class in org.apache.openjpa.tools.maven"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractOpenJpaMappingToolMojo.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 © 2011–2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMappingToolMojo.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html ============================================================================== --- websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html (added) +++ websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html Sun Sep 6 20:16:19 2020 @@ -0,0 +1,667 @@ +<!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 (1.8.0_252) on Sun Sep 06 22:02:04 CEST 2020 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractOpenJpaMojo (OpenJPA Maven Plugin 3.1.3-SNAPSHOT API)</title> +<meta name="date" content="2020-09-06"> +<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="AbstractOpenJpaMojo (OpenJPA Maven Plugin 3.1.3-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="../../../../../org/apache/openjpa/tools/maven/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="typeNameLink">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="typeNameLink">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="https://docs.oracle.com/javase/8/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="typeNameLabel">AbstractOpenJpaMojo</span> +extends org.apache.maven.plugin.AbstractMojo</pre> +<div class="block">Base class for OpenJPA maven tasks.</div> +<dl> +<dt><span class="simpleTagLabel">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="memberSummary" 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="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#classes">classes</a></span></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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#compileClasspathElements">compileClasspathElements</a></span></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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_DRIVER_NAME">OPTION_CONNECTION_DRIVER_NAME</a></span></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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_CONNECTION_PROPERTIES">OPTION_CONNECTION_PROPERTIES</a></span></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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES">OPTION_PROPERTIES</a></span></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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#OPTION_PROPERTIES_FILE">OPTION_PROPERTIES_FILE</a></span></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><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#project">project</a></span></code> +<div class="block">The Maven Project Object</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#workDir">workDir</a></span></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#AbstractOpenJpaMojo--">AbstractOpenJpaMojo</a></span>()</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="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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected org.apache.openjpa.lib.util.Options</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#createOptions--">createOptions</a></span>()</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 id="i1" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#extendRealmClasspath--">extendRealmClasspath</a></span>()</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 id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#findEntityClassFiles--">findEntityClassFiles</a></span>()</code> +<div class="block">Locates and returns a list of class files found under specified class + directory.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getClasspathElements--">getClasspathElements</a></span>()</code> +<div class="block">This function retrieves the injected classpath elements for the current mojo.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getEntityClasses--">getEntityClasses</a></span>()</code> +<div class="block">The File where the class files of the entities to enhance reside</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>protected <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>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getFilePaths-java.util.List-">getFilePaths</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> files)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected abstract org.apache.openjpa.lib.util.Options</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions--">getOptions</a></span>()</code> +<div class="block">Get the options for the various OpenJPA tools.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#skipMojo--">skipMojo</a></span>()</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/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="seeLabel">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="https://docs.oracle.com/javase/8/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="seeLabel">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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> 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="https://docs.oracle.com/javase/8/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="seeLabel">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="https://docs.oracle.com/javase/8/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="seeLabel">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="https://docs.oracle.com/javase/8/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="returnLabel">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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getClasspathElements()</pre> +<div class="block">This function retrieves the injected classpath elements for the current mojo.</div> +<dl> +<dt><span class="returnLabel">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 org.apache.openjpa.lib.util.Options getOptions() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Get the options for the various OpenJPA tools.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>populated Options</dd> +<dt><span class="throwsLabel">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="returnLabel">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 org.apache.openjpa.lib.util.Options 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="returnLabel">Returns:</span></dt> +<dd>the Options filled with the initial values</dd> +<dt><span class="throwsLabel">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="throwsLabel">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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/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="returnLabel">Returns:</span></dt> +<dd>list of class files.</dd> +<dt><span class="throwsLabel">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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getFilePaths(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> files)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>files</code> - List of files</dd> +<dt><span class="returnLabel">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> +<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="../../../../../org/apache/openjpa/tools/maven/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="typeNameLink">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="typeNameLink">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 © 2011–2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: websites/production/openjpa/content/builds/3.1.2/openjpa-maven-plugin/apidocs/org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html ------------------------------------------------------------------------------ svn:eol-style = native