blob: b9d08a3417d0b64cb59b3a6de7e10199a5c89956 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:08 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractOpenJpaEnhancerMojo (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<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="AbstractOpenJpaEnhancerMojo (OpenJPA Parent POM 2.4.3 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/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="strong">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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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="http://docs.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><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="strong">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="strong">Since:</span></dt>
<dd>1.1</dd>
<dt><span class="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#addDefaultConstructor">addDefaultConstructor</a></strong></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><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#enforcePropertyRestrictions">enforcePropertyRestrictions</a></strong></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><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#tmpClassLoader">tmpClassLoader</a></strong></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&nbsp;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&nbsp;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">&nbsp;</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/AbstractOpenJpaEnhancerMojo.html#AbstractOpenJpaEnhancerMojo()">AbstractOpenJpaEnhancerMojo</a></strong>()</code>&nbsp;</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">&nbsp;</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaEnhancerMojo.html#execute()">execute</a></strong>()</code></td>
</tr>
<tr class="rowColor">
<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/AbstractOpenJpaEnhancerMojo.html#getOptions()">getOptions</a></strong>()</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&nbsp;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&nbsp;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&nbsp;java.lang.<a href="http://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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>
</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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;void&nbsp;execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd><dt><span class="strong">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&nbsp;<a href="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</a>&nbsp;getOptions()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Get the options for the OpenJPA enhancer tool.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/openjpa/tools/maven/AbstractOpenJpaMojo.html#getOptions()">getOptions</a></code>&nbsp;in class&nbsp;<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="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>
</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/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="strong">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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>