| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.openjpa.tools.maven.AbstractOpenJpaMojo
public abstract class AbstractOpenJpaMojo
Base class for OpenJPA maven tasks.
| Field Summary | |
|---|---|
| protected  File | classesLocation where persistence-enabledclasses are located. | 
| protected  List<String> | compileClasspathElementsList of all class path elements that will be searched for the persistence-enabledclasses and resources expected by
 PCEnhancer. | 
| protected static String | OPTION_CONNECTION_DRIVER_NAMEthe string used for passing information about the connectionDriverName | 
| protected static String | OPTION_CONNECTION_PROPERTIESthe string used for passing information about the connectionProperties | 
| protected static String | OPTION_PROPERTIESThe properties option is used for passing information about the persistence.xml classpath resource and the default unit | 
| protected static String | OPTION_PROPERTIES_FILEthe properties option is used for passing information about the persistence.xml file location | 
| protected  org.apache.maven.project.MavenProject | projectThe Maven Project Object | 
| Fields inherited from interface org.apache.maven.plugin.Mojo | 
|---|
| ROLE | 
| Constructor Summary | |
|---|---|
| AbstractOpenJpaMojo()default ct | |
| Method Summary | |
|---|---|
| protected  Options | createOptions()This function will usually get called by getOptions() | 
| protected  void | extendRealmClasspath()This will prepare the current ClassLoader and add all jars and local classpaths (e.g. | 
| protected  List<File> | findEntityClassFiles()Locates and returns a list of class files found under specified class directory. | 
| protected  List<String> | getClasspathElements()This function retrieves the injected classpath elements for the current mojo. | 
| protected  File | getEntityClasses()The File where the class files of the entities to enhance reside | 
| protected  String[] | getFilePaths(List<File> files) | 
| protected abstract  Options | getOptions()Get the options for the various OpenJPA tools. | 
| protected  boolean | skipMojo()Determine if the mojo execution should get skipped. | 
| Methods inherited from class org.apache.maven.plugin.AbstractMojo | 
|---|
| getLog, getPluginContext, setLog, setPluginContext | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface org.apache.maven.plugin.Mojo | 
|---|
| execute | 
| Field Detail | 
|---|
protected File classes
persistence-enabled classes are located.
protected static final String OPTION_CONNECTION_DRIVER_NAME
protected static final String OPTION_CONNECTION_PROPERTIES
protected List<String> compileClasspathElements
persistence-enabled classes and resources expected by
 PCEnhancer.
protected org.apache.maven.project.MavenProject project
protected static final String OPTION_PROPERTIES_FILE
protected static final String OPTION_PROPERTIES
| Constructor Detail | 
|---|
public AbstractOpenJpaMojo()
| Method Detail | 
|---|
protected File getEntityClasses()
protected List<String> getClasspathElements()
protected abstract Options getOptions()
protected boolean skipMojo()
Determine if the mojo execution should get skipped.
This is the case if:skip is trueforceMojoExecution is false
true if the mojo execution should be skipped.protected Options createOptions()
getOptions()
protected void extendRealmClasspath()
                             throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException - on any error inside the mojo
protected List<File> findEntityClassFiles()
                                   throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException - if there was an error scanning class file
             resources.protected String[] getFilePaths(List<File> files)
files - List of files
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||