Code clean up

Author: simasch

src/main/java/org/utplsql/maven/plugin/CustomTypeMapping.java

@@ -2,6 +2,7 @@
 
 /**
  * Bean used by Maven to populate its model.
+ *
  * {@code
  * <customTypeMapping>
  *     <type>...</type>

src/main/java/org/utplsql/maven/plugin/UtPLSQLMojo.java

@@ -24,7 +24,7 @@
 import org.utplsql.api.reporter.Reporter;
 import org.utplsql.api.reporter.ReporterFactory;
 import org.utplsql.maven.plugin.helper.PluginDefault;
-import org.utplsql.maven.plugin.helper.SQLScannerHelper;
+import org.utplsql.maven.plugin.helper.SqlScannerHelper;
 import org.utplsql.maven.plugin.model.ReporterParameter;
 import org.utplsql.maven.plugin.reporter.ReporterWriter;
 
@@ -72,7 +72,10 @@ public class UtPLSQLMojo extends AbstractMojo {
     @Parameter
     protected final List<String> paths = new ArrayList<>();
 
-    // Sources Configuration
+    /**
+     * Sources Configuration
+     */
+
     @Parameter
     protected final List<Resource> sources = new ArrayList<>();
 
@@ -94,7 +97,9 @@ public class UtPLSQLMojo extends AbstractMojo {
     @Parameter
     private List<CustomTypeMapping> sourcesCustomTypeMapping;
 
-    // Tests Configuration
+    /**
+     * Tests Configuration
+     */
     @Parameter
     protected final List<Resource> tests = new ArrayList<>();
 
@@ -137,7 +142,9 @@ public class UtPLSQLMojo extends AbstractMojo {
     @Parameter
     protected boolean dbmsOutput;
 
-    // Color in the console, bases on Maven logging configuration.
+    /**
+     * Color in the console, bases on Maven logging configuration.
+     */
     private final boolean colorConsole = MessageUtils.isColorEnabled();
 
     private ReporterWriter reporterWriter;
@@ -242,9 +249,10 @@ private FileMapperOptions buildSourcesOptions() throws MojoExecutionException {
                 }
             }
 
-            List<String> scripts = SQLScannerHelper.findSQLs(project.getBasedir(), sources,
+            List<String> scripts = SqlScannerHelper.findSqlScripts(project.getBasedir(), sources,
                     PluginDefault.SOURCE_DIRECTORY, PluginDefault.SOURCE_FILE_PATTERN);
-            return createFileMapperOptions(scripts, sourcesOwner, sourcesRegexExpression, sourcesOwnerSubexpression, sourcesNameSubexpression, sourcesTypeSubexpression, sourcesCustomTypeMapping);
+            return createFileMapperOptions(scripts, sourcesOwner, sourcesRegexExpression, sourcesOwnerSubexpression,
+                    sourcesNameSubexpression, sourcesTypeSubexpression, sourcesCustomTypeMapping);
 
         } catch (Exception e) {
             throw new MojoExecutionException("Invalid <SOURCES> in your pom.xml", e);
@@ -263,7 +271,7 @@ private FileMapperOptions buildTestsOptions() throws MojoExecutionException {
                 }
             }
 
-            List<String> scripts = SQLScannerHelper.findSQLs(project.getBasedir(), tests, PluginDefault.TEST_DIRECTORY,
+            List<String> scripts = SqlScannerHelper.findSqlScripts(project.getBasedir(), tests, PluginDefault.TEST_DIRECTORY,
                     PluginDefault.TEST_FILE_PATTERN);
             return createFileMapperOptions(scripts, testsOwner, testsRegexExpression, testsOwnerSubexpression,
                     testsNameSubexpression, testsTypeSubexpression, testsCustomTypeMapping);
@@ -342,8 +350,7 @@ private List<Reporter> initReporters(Connection connection, Version utlVersion,
         return reporterList;
     }
 
-    private void logParameters(FileMapperOptions sourceMappingOptions, FileMapperOptions testMappingOptions,
-                               List<Reporter> reporterList) {
+    private void logParameters(FileMapperOptions sourceMappingOptions, FileMapperOptions testMappingOptions, List<Reporter> reporterList) {
         Log log = getLog();
         log.info("Invoking TestRunner with: " + targetDir);
 

src/main/java/org/utplsql/maven/plugin/helper/PluginDefault.java

@@ -5,9 +5,8 @@
 import java.util.Collections;
 
 /**
- * This class provides methods to retrieve the list of resources in the default
- * {@literal <source> and <test>} directories.
- * 
+ * This class provides methods to retrieve the list of resources in the default {@literal <source> and <test>} directories.
+ *
  * @author Alberto Hernández
  */
 public class PluginDefault {
@@ -37,7 +36,7 @@ private PluginDefault() {
 
     /**
      * This method returns {@link Resource} for the default {@code source} directory
-     * 
+     *
      * @return a {@link Resource}
      */
     public static Resource buildDefaultSource() {
@@ -46,7 +45,7 @@ public static Resource buildDefaultSource() {
 
     /**
      * This method returns {@link Resource} for the default {@code test} directory
-     * 
+     *
      * @return a {@link Resource}
      */
     public static Resource buildDefaultTest() {

src/main/java/org/utplsql/maven/plugin/helper/ReporterDefault.java

@@ -5,8 +5,7 @@
 /**
  * This class is an enumeration of all the known reporter in {@code utPLSQL}.
  * Furthermore, it defines the default output file for each {@link Reporter}.
- * In case the output file is set to {@code -}, it will mean the stdout of the
- * process.
+ * In case the output file is set to {@code -}, it will mean the stdout of the process.
  * 
  * @author Alberto Hernández
  */

…aven/plugin/helper/SQLScannerHelper.java …aven/plugin/helper/SqlScannerHelper.javasrc/main/java/org/utplsql/maven/plugin/helper/SQLScannerHelper.java renamed to src/main/java/org/utplsql/maven/plugin/helper/SqlScannerHelper.java src/main/java/org/utplsql/maven/plugin/helper/SQLScannerHelper.java renamed to src/main/java/org/utplsql/maven/plugin/helper/SqlScannerHelper.java

@@ -15,10 +15,9 @@
  *
  * @author Alberto Hernández
  */
-public class SQLScannerHelper {
+public class SqlScannerHelper {
 
-    private SQLScannerHelper() {
-        // NA
+    private SqlScannerHelper() {
     }
 
     /**
@@ -30,7 +29,7 @@ private SQLScannerHelper() {
      * @param defaultFilePattern the default file pattern
      * @return a list of the files found
      */
-    public static List<String> findSQLs(File baseDir, List<Resource> resources, String defaultDirectory, String defaultFilePattern) {
+    public static List<String> findSqlScripts(File baseDir, List<Resource> resources, String defaultDirectory, String defaultFilePattern) {
         List<String> founds = new ArrayList<>();
 
         for (Resource resource : resources) {
@@ -61,8 +60,7 @@ private static DirectoryScanner buildScanner(String baseDir, Resource resource)
         if (resource != null) {
             File fileBaseDir = new File(baseDir, resource.getDirectory());
             if (!fileBaseDir.exists() || !fileBaseDir.isDirectory() || !fileBaseDir.canRead()) {
-                throw new IllegalArgumentException(
-                        format("Invalid <directory> %s in resource. Check your pom.xml", resource.getDirectory()));
+                throw new IllegalArgumentException(format("Invalid <directory> %s in resource. Check your pom.xml", resource.getDirectory()));
             }
 
             DirectoryScanner scanner = new DirectoryScanner();

src/main/java/org/utplsql/maven/plugin/model/ReporterParameter.java

@@ -4,14 +4,15 @@
 
 /**
  * Represents a reporter parameter in the pom file.
+ *
  * {@code
  * <reporter>
  *     <name>...</name>
  *     <fileOutput>...</fileOutput>
  *     <consoleOutput>...</consoleOutput>
  * </reporter>
  * }
- * 
+ *
  * @author Alberto Hernández
  */
 public class ReporterParameter {
@@ -20,16 +21,9 @@ public class ReporterParameter {
     private String fileOutput;
     private Boolean consoleOutput;
 
-    /**
-     * Creates a new reporter parameter.
-     */
-    public ReporterParameter() {
-        super();
-    }
-
     /**
      * Returns the reporter name.
-     * 
+     *
      * @return the reporter name
      */
     public String getName() {
@@ -38,7 +32,7 @@ public String getName() {
 
     /**
      * Sets the reporter name.
-     * 
+     *
      * @param name the reporter name
      */
     public void setName(String name) {
@@ -47,7 +41,7 @@ public void setName(String name) {
 
     /**
      * Returns reporter output file.
-     * 
+     *
      * @return the output file name
      */
     public String getFileOutput() {
@@ -56,7 +50,7 @@ public String getFileOutput() {
 
     /**
      * Returns whether the file output is enabled or not.
-     * 
+     *
      * @return true if the file output is enabled, false otherwise
      */
     public boolean isFileOutput() {
@@ -65,7 +59,7 @@ public boolean isFileOutput() {
 
     /**
      * Sets the output file.
-     * 
+     *
      * @param fileOutput the output file name
      */
     public void setFileOutput(String fileOutput) {
@@ -74,7 +68,7 @@ public void setFileOutput(String fileOutput) {
 
     /**
      * Returns the console output option.
-     * 
+     *
      * @return the console output option
      */
     public Boolean getConsoleOutput() {
@@ -83,7 +77,7 @@ public Boolean getConsoleOutput() {
 
     /**
      * Returns whether the console output should be enabled or not.
-     * 
+     *
      * @return true if console output is enable, false otherwise
      */
     public Boolean isConsoleOutput() {
@@ -92,7 +86,7 @@ public Boolean isConsoleOutput() {
 
     /**
      * Sets the console output option.
-     * 
+     *
      * @param consoleOutput the console output option
      */
     public void setConsoleOutput(boolean consoleOutput) {

src/main/java/org/utplsql/maven/plugin/reporter/ReporterWriter.java

@@ -65,14 +65,11 @@ public void writeReporters(Connection connection) throws MojoExecutionException
         }
     }
 
-    private void writeReports(Connection connection, Reporter reporter, ReporterParameter reporterParameter)
-            throws MojoExecutionException {
-        List<PrintStream> printStreams = new ArrayList<>();
-        FileOutputStream fout = null;
-
-        //
+    private void writeReports(Connection connection, Reporter reporter, ReporterParameter reporterParameter) throws MojoExecutionException {
+        FileOutputStream fileOutputStream = null;
         try {
             OutputBuffer buffer = OutputBufferProvider.getCompatibleOutputBuffer(databaseVersion, reporter, connection);
+            List<PrintStream> printStreams = new ArrayList<>();
 
             if (reporterParameter.isFileOutput()) {
 
@@ -86,11 +83,11 @@ private void writeReports(Connection connection, Reporter reporter, ReporterPara
                     file.getParentFile().mkdirs();
                 }
 
-                fout = new FileOutputStream(file);
+                fileOutputStream = new FileOutputStream(file);
                 log.info(format("Writing report %s to %s", reporter.getTypeName(), file.getAbsolutePath()));
 
                 // Added to the Report
-                printStreams.add(new PrintStream(fout));
+                printStreams.add(new PrintStream(fileOutputStream));
             }
 
             if (reporterParameter.isConsoleOutput()) {
@@ -101,9 +98,9 @@ private void writeReports(Connection connection, Reporter reporter, ReporterPara
         } catch (Exception e) {
             throw new MojoExecutionException("Unexpected error opening file ouput ", e);
         } finally {
-            if (fout != null) {
+            if (fileOutputStream != null) {
                 try {
-                    fout.close();
+                    fileOutputStream.close();
                 } catch (IOException e) {
                     log.info(format("Failed to closing the reporting %s", reporterParameter.getClass()));
                 }