Integration of the maven-plugin-plugin for automated helpmojo-generation

[hibernate4-maven-plugin] / src / main / java / de / juplo / plugins / hibernate4 / Hbm2DdlMojo.java

diff --git a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java
index 7cae92f..2ad0a29 100644 (file)
--- a/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java
+++ b/src/main/java/de/juplo/plugins/hibernate4/Hbm2DdlMojo.java
@@ -82,8 +82,10 @@ public class Hbm2DdlMojo extends AbstractMojo
 
   /**
    * The maven project.
+   * <p>
+   * Only needed internally.
    *
-   * @parameter expression="${project}"
+   * @parameter property="project"
    * @required
    * @readonly
    */
@@ -91,22 +93,60 @@ public class Hbm2DdlMojo extends AbstractMojo
 
   /**
    * Build-directory.
+   * <p>
+   * Only needed internally.
    *
-   * @parameter expression="${project.build.directory}"
+   * @parameter property="project.build.directory"
+   * @required
+   * @readonly
    */
   private String buildDirectory;
 
   /**
-   * Class-directory to scan.
+   * Classes-Directory to scan.
+   * <p>
+   * This parameter defaults to the maven build-output-directory for classes.
+   * Additonally, all dependencies are scanned for annotated classes.
    *
-   * @parameter expression="${project.build.outputDirectory}"
+   * @parameter property="project.build.outputDirectory"
    */
   private String outputDirectory;
 
+  /**
+   * Wether to scan test-classes too, or not.
+   * <p>
+   * If this parameter is set to <code>true</code> the test-classes of the
+   * artifact will be scanned for hibernate-annotated classes additionally.
+   *
+   * @parameter property="hibernate.export.scan_testclasses" default-value="false"
+   */
+  private boolean scanTestClasses;
+
+  /**
+   * Test-Classes-Directory to scan.
+   * <p>
+   * This parameter defaults to the maven build-output-directory for
+   * test-classes.
+   * <p>
+   * This parameter is only used, when <code>scanTestClasses</code> is set
+   * to <code>true</code>!
+   *
+   * @parameter property="project.build.testOutputDirectory"
+   */
+  private String testOutputDirectory;
+
   /**
    * Skip execution
+   * <p>
+   * If set to <code>true</code>, the execution is skipped.
+   * <p>
+   * A skipped excecution is signaled via the maven-property
+   * <code>${hibernate.export.skipped}</code>.
+   * <p>
+   * The excecution is skipped automatically, if no modified or newly added
+   * annotated classes are found and the dialect was not changed.
    *
-   * @parameter expression="${maven.test.skip}" default-value="false"
+   * @parameter property="maven.test.skip" default-value="false"
    */
   private boolean skip;
 
@@ -114,44 +154,46 @@ public class Hbm2DdlMojo extends AbstractMojo
    * Force execution
    * <p>
    * Force execution, even if no modified or newly added annotated classes
-   * where found. <code>skip</code> takes precedence over <code>force</code>.
+   * where found and the dialect was not changed.
+   * <p>
+   * <code>skip</code> takes precedence over <code>force</code>.
    *
-   * @parameter expression="${hibernate.export.force}" default-value="false"
+   * @parameter property="hibernate.export.force" default-value="false"
    */
   private boolean force;
 
   /**
    * SQL-Driver name.
    *
-   * @parameter expression="${hibernate.connection.driver_class}
+   * @parameter property="hibernate.connection.driver_class"
    */
   private String driverClassName;
 
   /**
    * Database URL.
    *
-   * @parameter expression="${hibernate.connection.url}"
+   * @parameter property="hibernate.connection.url"
    */
   private String url;
 
   /**
    * Database username
    *
-   * @parameter expression="${hibernate.connection.username}"
+   * @parameter property="hibernate.connection.username"
    */
   private String username;
 
   /**
    * Database password
    *
-   * @parameter expression="${hibernate.connection.password}"
+   * @parameter property="hibernate.connection.password"
    */
   private String password;
 
   /**
    * Hibernate dialect.
    *
-   * @parameter expression="${hibernate.dialect}"
+   * @parameter property="hibernate.dialect"
    */
   private String hibernateDialect;
 
@@ -165,45 +207,47 @@ public class Hbm2DdlMojo extends AbstractMojo
   /**
    * Target of execution:
    * <ul>
-   *   <li><strong>NONE</strong> do nothing - just validate the configuration</li>
-   *   <li><strong>EXPORT</strong> create database <strong>(DEFAULT!)</strong></li>
+   *   <li><strong>NONE</strong> do nothing - just validate the configuration (forces excecution, signals skip)</li>
+   *   <li><strong>EXPORT</strong> create database (<strong>DEFAULT!</strong>. forces excecution, signals skip)</li>
    *   <li><strong>SCRIPT</strong> export schema to SQL-script</li>
    *   <li><strong>BOTH</strong></li>
    * </ul>
-   * @parameter expression="${hibernate.export.target}" default-value="EXPORT"
+   *
+   * @parameter property="hibernate.export.target" default-value="EXPORT"
    */
   private String target;
 
   /**
-   * Type of export.
+   * Type of execution.
    * <ul>
    *   <li><strong>NONE</strong> do nothing - just validate the configuration</li>
    *   <li><strong>CREATE</strong> create database-schema</li>
    *   <li><strong>DROP</strong> drop database-schema</li>
-   *   <li><strong>BOTH</strong> <strong>(DEFAULT!)</strong></li>
+   *   <li><strong>BOTH</strong> (<strong>DEFAULT!</strong>)</li>
    * </ul>
-   * @parameter expression="${hibernate.export.type}" default-value="BOTH"
+   *
+   * @parameter property="hibernate.export.type" default-value="BOTH"
    */
   private String type;
 
   /**
    * Output file.
    *
-   * @parameter expression="${hibernate.export.schema.filename}" default-value="${project.build.directory}/schema.sql"
+   * @parameter property="hibernate.export.schema.filename" default-value="${project.build.directory}/schema.sql"
    */
   private String outputFile;
 
   /**
    * Delimiter in output-file.
    *
-   * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";"
+   * @parameter property="hibernate.export.schema.delimiter" default-value=";"
    */
   private String delimiter;
 
   /**
    * Format output-file.
    *
-   * @parameter expression="${hibernate.export.schema.format}" default-value="true"
+   * @parameter property="hibernate.export.schema.format" default-value="true"
    */
   private boolean format;
 
@@ -262,6 +306,8 @@ public class Hbm2DdlMojo extends AbstractMojo
     {
       getLog().debug("Creating ClassLoader for project-dependencies...");
       List<String> classpathFiles = project.getCompileClasspathElements();
+      if (scanTestClasses)
+        classpathFiles.addAll(project.getTestClasspathElements());
       URL[] urls = new URL[classpathFiles.size()];
       for (int i = 0; i < classpathFiles.size(); ++i)
       {
@@ -293,6 +339,15 @@ public class Hbm2DdlMojo extends AbstractMojo
       getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
       URL dirUrl = dir.toURI().toURL();
       db.scanArchives(dirUrl);
+      if (scanTestClasses)
+      {
+        dir = new File(testOutputDirectory);
+        if (!dir.exists())
+          throw new MojoExecutionException("Cannot scan for annotated test-classes in " + testOutputDirectory + ": directory does not exist!");
+        getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
+        dirUrl = dir.toURI().toURL();
+        db.scanArchives(dirUrl);
+      }
 
       Set<String> classNames = new HashSet<String>();
       if (db.getAnnotationIndex().containsKey(Entity.class.getName()))