db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From m..@apache.org
Subject [db-jdo] branch master updated: Fixed javadoc warnings
Date Sat, 22 Feb 2020 20:57:18 GMT
This is an automated email from the ASF dual-hosted git repository.

mbo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/db-jdo.git


The following commit(s) were added to refs/heads/master by this push:
     new 85c53f4  Fixed javadoc warnings
85c53f4 is described below

commit 85c53f4f25713be3027d9018a069cc75ea4131ab
Author: Michael Bouschen <mbo@apache.org>
AuthorDate: Sat Feb 22 21:57:05 2020 +0100

    Fixed javadoc warnings
---
 exectck/pom.xml                                    |  6 ++
 .../org/apache/jdo/exectck/AbstractTCKMojo.java    | 43 ++++--------
 .../main/java/org/apache/jdo/exectck/Enhance.java  | 21 ++----
 .../src/main/java/org/apache/jdo/exectck/Help.java |  7 +-
 .../java/org/apache/jdo/exectck/InstallSchema.java | 39 +++++------
 .../java/org/apache/jdo/exectck/PropertyUtils.java |  2 +-
 .../main/java/org/apache/jdo/exectck/RunTCK.java   | 80 ++++++++--------------
 .../java/org/apache/jdo/exectck/SQLFileLoader.java |  2 +-
 8 files changed, 76 insertions(+), 124 deletions(-)

diff --git a/exectck/pom.xml b/exectck/pom.xml
index 0dece2d..58a675e 100644
--- a/exectck/pom.xml
+++ b/exectck/pom.xml
@@ -73,6 +73,12 @@
             <artifactId>maven-plugin-api</artifactId>
         </dependency>
         <dependency>
+            <groupId>org.apache.maven.plugin-tools</groupId>
+            <artifactId>maven-plugin-annotations</artifactId>
+            <version>3.4</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
         </dependency>
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java b/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java
index db22677..24054b4 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java
@@ -25,6 +25,7 @@ import java.util.Properties;
 import org.apache.commons.io.FileUtils;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.Parameter;
 
 /**
  * Abstract Mojo to be extended for the actual goals of this maven plugin.
@@ -33,95 +34,75 @@ public abstract class AbstractTCKMojo extends AbstractMojo {
 
 	/**
      * Location of TCK generated output.
-     * @parameter property="project.build.directory"
-     *      default-value="${basedir}/target"
-     * @required
      */
+    @Parameter( property = "project.build.directory", defaultValue = "${basedir}/target",
required = true)
     protected String buildDirectory;
 
     /**
      * Location of the logs directory.
-     * @parameter property="project.log.directory"
-     *      default-value="${project.build.directory}/logs"
-     * @required
      */
+    @Parameter( property = "project.log.directory", defaultValue = "${project.build.directory}/logs",
required = true)
     protected File logsDirectory;
 
     /**
      * Location of the configuration directory.
-     * @parameter property="project.conf.directory"
-     *      default-value="${basedir}/src/main/resources/conf"
-     * @required
      */
+    @Parameter( property = "project.conf.directory", defaultValue = "${basedir}/src/main/resources/conf",
required = true)
     protected String confDirectory;
 
     /**
      * Location of the configuration directory.
-     * @parameter property="project.sql.directory"
-     *      default-value="${basedir}/src/main/resources/sql"
-     * @required
      */
+    @Parameter( property = "project.sql.directory", defaultValue = "${basedir}/src/main/resources/sql",
required = true)
     protected String sqlDirectory;
 
     /**
      * List of configuration files, each describing a test configuration.
      * Note: Collection can only be configured in pom.xml. Using multi-valued
      *       type because long String cannot be broken across lines in pom.xml.
-     * @parameter
-     * @optional
      */
+    @Parameter
     protected Collection<String> cfgs;
 
     /**
      * List of configuration files, each describing a test configuration.
      * Allows command line override of configured cfgs value.
-     * @parameter property="jdo.tck.cfglist"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.cfglist")
     protected String cfgList;
 
     /**
      * List of databases to run tests under.
      * Currently only derby is supported.
-     * @parameter property="jdo.tck.dblist"
-     *      default-value="derby"
-     * @required
      */
+    @Parameter( property = "jdo.tck.dblist", defaultValue = "derby", required = true)
     protected String dblist;
 
     /**
      * Implementation to be tested (jdori or iut).
      * Any value other than "jdori" will test an appropriately configured IUT
-     * @parameter property="jdo.tck.impl"
-     *      default-value="jdori"
-     * @required
      */
+    @Parameter( property = "jdo.tck.impl", defaultValue = "jdori", required = true)
     protected String impl;
 
     /**
      * Location of implementation log file.
-     * @parameter property="jdo.tck.impl.logfile"
-     *      default-value="${user.dir}/datanucleus.txt"
-     * @required
      */
+    @Parameter( property = "jdo.tck.impl.logfile", defaultValue = "${user.dir}/datanucleus.txt",
required = true)
     protected String implLogFile;
 
     /**
      * Classpath including the dependencies using : as separator between entries.
-     * @parameter property="jdo.tck.dependencyClasspath"
-     *      default-value=""
-     * @required
      */
+    @Parameter( property = "jdo.tck.dependencyClasspath", defaultValue = "", required = true)
     protected String dependencyClasspath;
 
     protected Collection<String> dbs = new HashSet<String>();
 
     /**
      * List of identity types to be tested.
-     * @parameter property="jdo.tck.identitytypes"
-     *      default-value="applicationidentity datastoreidentity"
-     * @required
      */
+    @Parameter( property = "jdo.tck.identitytypes", defaultValue = "applicationidentity datastoreidentity",
required = true)
     protected String identitytypes;
 
     protected Collection<String> idtypes = new HashSet<String>();
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java b/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java
index 5897341..eb86ff7 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java
@@ -21,9 +21,10 @@ import java.net.MalformedURLException;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import org.apache.commons.io.FileUtils;
-import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
 
 import java.io.File;
 import java.io.IOException;
@@ -38,11 +39,8 @@ import javax.jdo.JDOHelper;
 
 /**
  * Goal that enhances test classes for testing a JDO implementation.
- *
- * @goal enhance
- *
- * @phase integration-test
  */
+@Mojo( name = "enhance" )
 public class Enhance extends AbstractTCKMojo {
 
     private static final String[] PC_PKG_DIRS = {
@@ -52,25 +50,20 @@ public class Enhance extends AbstractTCKMojo {
     };
     /**
      * Location of TCK generated output.
-     * @parameter property="jdo.tck.doEnhance"
-     *      default-value="true"
-     * @required
      */
+    @Parameter( property = "jdo.tck.doEnhance", defaultValue = "true", required = true)
     private boolean doEnhance;
+
     /**
      * Root of the TCK source installation.
-     * @parameter property="project.src.directory"
-     *      default-value="${basedir}/src/main/resources"
-     * @required
      */
+    @Parameter( property = "project.src.directory", defaultValue = "${basedir}/src/main/resources",
required = true)
     private String srcDirectory;
 
     /**
      * List of identity types to be tested.
-     * @parameter property="jdo.tck.identitytypes"
-     *      default-value="applicationidentity datastoreidentity"
-     * @required
      */
+    @Parameter( property = "jdo.tck.identitytypes", defaultValue = "applicationidentity datastoreidentity",
required = true)
     private String identitytypes;
 
     private Collection<String> idtypes;
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/Help.java b/exectck/src/main/java/org/apache/jdo/exectck/Help.java
index 86f3591..10828a8 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/Help.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/Help.java
@@ -20,15 +20,12 @@ package org.apache.jdo.exectck;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Mojo;
 
 /**
  * Goal that displays help text for the exectck Maven plugin.
- *
- * @goal help
- *
- * @phase integration-test
- *
  */
+@Mojo( name = "help" )
 public class Help extends AbstractMojo{
 
     @Override
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java b/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java
index 0d398da..eeb01d0 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java
@@ -17,6 +17,8 @@ package org.apache.jdo.exectck;
 
 import org.apache.commons.io.FileUtils;
 import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
 
 import java.io.File;
 import java.io.IOException;
@@ -31,19 +33,14 @@ import java.util.List;
 
 /**
  * Goal that installs a database schema for testing a JDO implementation.
- *
- * @goal installSchema
- * 
- * @phase integration-test
  */
+@Mojo( name = "installSchema" )
 public class InstallSchema extends AbstractTCKMojo {
 
     /**
      * Location of TCK generated output.
-     * @parameter property="jdo.tck.doInstallSchema"
-     *      default-value="true"
-     * @required
      */
+    @Parameter( property = "jdo.tck.doInstallSchema", defaultValue = "true", required = true)
     private boolean doInstallSchema;
 
     /**
@@ -174,8 +171,8 @@ public class InstallSchema extends AbstractTCKMojo {
 
     /**
      *
-     * @param db
-     * @param dbDirName
+     * @param db database name
+     * @param dbDirName database home directory
      */
     protected void initializeDB(String db, String dbDirName) {
         if ("derby".equalsIgnoreCase(db)) {
@@ -185,8 +182,8 @@ public class InstallSchema extends AbstractTCKMojo {
 
     /**
      *
-     * @param db
-     * @param dbDirName
+     * @param db database name
+     * @param dbDirName database home directory
      */
     protected void finalizeDB(String db, String dbDirName) {
         if ("derby".equalsIgnoreCase(db)) {
@@ -199,11 +196,12 @@ public class InstallSchema extends AbstractTCKMojo {
     }
 
     /**
-     * 
-     * @param dbDirName
-     * @param sqlFileName
-     * @param outFileName
-     * @throws MojoExecutionException
+     *
+     * @param db database name
+     * @param dbDirName database home directory
+     * @param sqlFileName name of the sql file
+     * @param outFileName name of the output file
+     * @throws MojoExecutionException exception indicating error case
      */
     protected void loadSQLFileUsingIJ(String db, String dbDirName, String sqlFileName, String
outFileName)
             throws MojoExecutionException {
@@ -220,10 +218,11 @@ public class InstallSchema extends AbstractTCKMojo {
 
     /**
      *
-     * @param dbDirName
-     * @param sqlFileName
-     * @param outFileName
-     * @throws MojoExecutionException
+     * @param db database name
+     * @param dbDirName database home directory
+     * @param sqlFileName name of the sql file
+     * @param outFileName name of the output file
+     * @throws MojoExecutionException exception indicating error case
      */
     protected void loadSQLFileUsingJDBC(String db, String dbDirName,
                                         String sqlFileName, String outFileName)
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/PropertyUtils.java b/exectck/src/main/java/org/apache/jdo/exectck/PropertyUtils.java
index 9fc3528..9ca7d95 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/PropertyUtils.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/PropertyUtils.java
@@ -62,7 +62,7 @@ public class PropertyUtils {
 
     /**
      * Parses a set of config files for the mapping entry and
-     * provides the mapping values in a Collection<String>.
+     * provides the mapping values in a Collection.
      * @param cfglist config file names
      * @param confDir directory where config files are found
      * @param mappings object to containg mapping values
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java b/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
index 29a8a61..94c0345 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
@@ -33,15 +33,14 @@ import org.apache.commons.io.FileUtils;
 import org.apache.jdo.exectck.Utilities.InvocationResult;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
 
 /**
  * Goal that runs the JDO TCK against the Reference Implementation (RI)
  * or an implementation under test (IUT).
- *
- * @goal runtck
- *
- * @phase integration-test
  */
+@Mojo( name = "runtck" )
 public class RunTCK extends AbstractTCKMojo {
 
     private static final String TCK_PARAM_ON_FAILURE_FAIL_FAST = "failFast"; 
@@ -50,127 +49,104 @@ public class RunTCK extends AbstractTCKMojo {
 
     /**
      * To skip running of TCK, set to false.
-     * @parameter property="jdo.tck.doRunTCK"
-     *      default-value=true
-     * @required
      */
+    @Parameter( property = "jdo.tck.doRunTCK", defaultValue = "true", required = true)
     private boolean doRunTCK;
 
     /**
      * To run the RunTCK plugin goal in verbose mode.
-     * @parameter property="jdo.tck.runTCKVerbose"
-     *      default-value=false
-     * @required
      */
+    @Parameter( property = "jdo.tck.runTCKVerbose", defaultValue = "false", required = true)
     private boolean runtckVerbose;
 
     /**
      * Define handling of TCK failures.
-     * @parameter property="jdo.tck.onFailure"
-     *      default-value="failGoal"
-     * @required
      */
+    @Parameter( property = "jdo.tck.onFailure", defaultValue = "failGoal", required = true)
     private String onFailure;
 
     /**
      * Run the TCK in a debugger.
-     * @parameter property="jdo.tck.debugTCK"
-     *      default-value=false
-     * @required
      */
+    @Parameter( property = "jdo.tck.debugTCK", defaultValue = "false", required = true)
     private boolean debugTCK;
 
     /**
      * Location of third party libraries such as JNDI.
-     * @parameter property="project.lib.ext.directory"
-     *      default-value="${basedir}/../lib/ext"
-     * @required
      */
+    @Parameter( property = "project.lib.ext.directory", defaultValue = "${basedir}/../lib/ext",
required = true)
     private String extLibsDirectory;
 
     /**
      * Location of implementation log file.
-     * @parameter property="jdo.tck.impl.logfile"
-     *      default-value="${user.dir}/datanucleus.txt"
-     * @required
      */
+    @Parameter( property = "jdo.tck.impl.logfile", defaultValue = "${user.dir}/datanucleus.txt",
required = true)
     private String implLogFile;
 
     /**
      * Name of file in src/conf containing pmf properties.
-     * @parameter property="jdo.tck.pmfproperties"
-     *      default-value="jdori-pmf.properties"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.pmfproperties", defaultValue = "jdori-pmf.properties")
     private String pmfProperties;
 
     /**
      * Name of file in src/conf containing property jdo.tck.exclude,
      *   whose value is a list of files to be excluded from testing.
-     * @parameter property="jdo.tck.excludefile"
-     *      default-value="exclude.list"
-     * @required
      */
+    @Parameter( property = "jdo.tck.excludefile", defaultValue = "exclude.list", required
= true)
     private String exclude;
 
     /**
      * Run the TCK tests in verbose mode.
-     * @parameter property="jdo.tck.verbose"
-     *      default-value="false"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.verbose", defaultValue = "false")
     private String verbose;
+
     /**
      * To retain test output for debugging, set to false.
-     * @parameter property="jdo.tck.cleanupaftertest"
-     *      default-value="true"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.cleanupaftertest", defaultValue = "true")
     private String cleanupaftertest;
+
     /**
      * Properties to use in accessing database.
-     * @parameter property="database.runtck.sysproperties"
-     *      default-value="-Dderby.system.home=${basedir}/target/database/derby"
-     * @optional
      */
+    @Parameter( property = "database.runtck.sysproperties",
+                defaultValue = "-Dderby.system.home=${basedir}/target/database/derby")
     private String dbproperties;    // NOTE: only allows for one db
+
     /**
      * Properties to use in accessing database.
-     * @parameter property="jdo.tck.signaturefile"
-     *      default-value="${basedir}/src/main/resources/conf/jdo-signatures.txt"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.signaturefile",
+                defaultValue = "${basedir}/src/main/resources/conf/jdo-signatures.txt")
     private String signaturefile;
+
     /**
      * JVM properties.
-     * @parameter property="jdo.tck.jvmproperties"
-     *      default-value="-Xmx512m"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.jvmproperties", defaultValue = "-Xmx512m")
     private String jvmproperties;
 
     /**
      * User-supplied arguments for debug directives.
-     * @parameter property="jdo.tck.debug.jvmargs"
-     *      default-value="-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=${jdo.tck.debug.port}"
-     * @optional
      */
+    @Parameter( property = "jdo.tck.debug.jvmargs",
+                defaultValue = "-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=${jdo.tck.debug.port}")
     private String debugDirectives;
 
     /**
      * Class used to run a batch of tests.
-     * @parameter property="jdo.tck.testrunnerclass"
-     *      default-value="org.apache.jdo.tck.util.BatchTestRunner"
-     * @required
      */
+    @Parameter( property = "jdo.tck.testrunnerclass", defaultValue = "org.apache.jdo.tck.util.BatchTestRunner",
+                required = true)
     private String testRunnerClass;
 
     /**
      * Class used to output test result and configuration information.
-     * @parameter property="jdo.tck.resultprinterclass"
-     *      default-value="org.apache.jdo.tck.util.BatchResultPrinter"
-     * @required
      */
+    @Parameter( property = "jdo.tck.resultprinterclass", defaultValue = "org.apache.jdo.tck.util.BatchResultPrinter",
+                required = true)
     private String resultPrinterClass;
 
     /**
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/SQLFileLoader.java b/exectck/src/main/java/org/apache/jdo/exectck/SQLFileLoader.java
index 71d61a4..7bd42c6 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/SQLFileLoader.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/SQLFileLoader.java
@@ -331,7 +331,7 @@ public class SQLFileLoader {
 
     /**
      * main method For testing; prints the internal state to System.out.
-     * @param args
+     * @param args command line arguments
      */
     public static void main(String[] args) {
         for (String arg : args) {


Mime
View raw message