Oracle compliant ALTER TABLE ADD/MODIFY deparser (#1163)

* javadoc-fixes

* fix check-style error : assignment to parameter not allowed

* import for javadoc reference

* javadoc - add description to parameter "fqn" (fix warning)

* remove doclint=none, but exclude package with exclude package with
generated sources (javacc/jjtree) from javadoc

* Implement Oracle Hints for INSERT, UPDATE, MERGE, DELETE

* Correct CreateIndex TailOptions
Add a Test Case for CreateIndex TailOptions

* Add WHERE expression to MergeInsert
Add test case for MergeInsert WHERE expression

* Fix Issue #1156: ALTER TABLE ADD FOREIGN KEY with schema reference
Add a specific test case

* Fix Issue #1157: Oracle does not accept COLUMN keyword in ALTER TABLE ADD/MODIFY
Correct the test cases accepting a non existing COLUMN keyword
Add a specific test cases

* Fix Issue #1164 UNIQUE after PRIMARY KEY
Add test case for UNIQUE after PRIMARY KEY

* Switch of warnings for un-fixble method namings

* Switch of warnings for un-fixble method namings

* Activate PMD and define our own ruleset

* Execute PMD before building/testing in order to fail early

* Fix 63 PMD warnings

* Activate rule "PMD.CyclomaticComplexity" in order to simulate the Codazy checks
Apply @SuppressWarnings({"PMD.CyclomaticComplexity"}) where this rule throws an unavoidable warning (especially for toString() and deparse())

* Activate rule , "PMD.ExcessiveMethodLength" in order to simulate the Codazy checks
Apply @SuppressWarnings({"PMD.ExcessiveMethodLength"}) where this rule throws an unavoidable warning (especially for toString() and deparse())
Refactor an ENUM name

* Refactor an ENUM name and reflect this also in the JavaCC Parser definition file

Co-authored-by: gitmotte <www@synbee.at>

Author: manticore-projects

pom.xml

@@ -254,7 +254,7 @@
             <id>attach-javadocs</id>
             <configuration>
               <additionalparam>${javadoc.opts}</additionalparam>
-              <doclint>none</doclint>
+              <excludePackageNames>net.sf.jsqlparser.parser</excludePackageNames> 
             </configuration>
             <goals>
               <goal>jar</goal>
@@ -327,11 +327,12 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.1.0</version>
+        <version>3.1.1</version>
         <configuration>
           <useStandardDocletOptions>true</useStandardDocletOptions>
           <maxmemory>800m</maxmemory>
-          <doclint>none</doclint>
+          <doclint>all, -missing</doclint>
+          <excludePackageNames>net.sf.jsqlparser.parser</excludePackageNames>                          
         </configuration>
       </plugin>
       <plugin>
@@ -397,6 +398,8 @@
         </plugins>
       </build>
     </profile>
+    
+    <!--
     <profile>
       <id>doclint-java8-disable</id>
       <activation>
@@ -406,6 +409,7 @@
         <javadoc.opts>-Xdoclint:none</javadoc.opts>
       </properties>
     </profile>
+    -->
     <profile>
       <id>check.sources</id>
       <activation>

src/main/java/net/sf/jsqlparser/expression/CaseExpression.java

@@ -20,25 +20,25 @@
 /**
  * CASE/WHEN expression.
  *
- * Syntax:  <code><pre>
+ * Syntax:  <pre><code>
  * CASE
  * WHEN condition THEN expression
  * [WHEN condition THEN expression]...
  * [ELSE expression]
  * END
- * </pre></code>
+ * </code></pre>
  *
- * <br/>
- * or <br/>
- * <br/>
+ * <br>
+ * or <br>
+ * <br>
  *
- * <code><pre>
+ * <pre><code>
  * CASE expression
  * WHEN condition THEN expression
  * [WHEN condition THEN expression]...
  * [ELSE expression]
  * END
- * </pre></code>
+ * </code></pre>
  *
  */
 public class CaseExpression extends ASTNodeAccessImpl implements Expression {

src/main/java/net/sf/jsqlparser/expression/DateValue.java

@@ -31,7 +31,7 @@ public DateValue(Date value) {
     /**
      * A Date in the form {d 'yyyy-mm-dd'}
      *
-     * @param value
+     * @param value The text presentation of the Date to be parsed.
      */
     public DateValue(String value) {
         this(Date.valueOf(value.substring(1, value.length() - 1)));

src/main/java/net/sf/jsqlparser/expression/Function.java

@@ -71,7 +71,6 @@ public boolean isIgnoreNulls() {
      * This is at the moment only necessary for AnalyticExpression initialization and not for normal
      * functions. Therefore there is no deparsing for it for normal functions.
      *
-     * @param ignoreNulls
      */
     public void setIgnoreNulls(boolean ignoreNulls) {
         this.ignoreNulls = ignoreNulls;

src/main/java/net/sf/jsqlparser/expression/JdbcParameter.java

@@ -12,7 +12,7 @@
 import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
 
 /**
- * A '?' in a statement or a ?<number> e.g. ?4
+ * A '?' in a statement or a ?&lt;number&gt; e.g. ?4
  */
 public class JdbcParameter extends ASTNodeAccessImpl implements Expression {
 

src/main/java/net/sf/jsqlparser/parser/SimpleCharStream.java

@@ -149,6 +149,8 @@ protected void FillBuff() throws IOException {
 
     /**
      * Start.
+     * @return the character read
+     * @throws IOException
      */
     public char BeginToken() throws IOException {
         tokenBegin = -1;
@@ -202,6 +204,8 @@ private char readChar(int pos) {
 
     /**
      * Read a character.
+     * @return the character read
+     * @throws IOException
      */
     public char readChar() throws IOException {
         if (inBuf > 0) {
@@ -227,54 +231,57 @@ public char readChar() throws IOException {
         return c;
     }
 
-    @Deprecated
+    
     /**
+     * @return the column
      * @deprecated @see #getEndColumn
      */
-
+    @Deprecated
     public int getColumn() {
         return bufcolumn[bufpos];
     }
 
-    @Deprecated
+    
     /**
+     * @return the line
      * @deprecated @see #getEndLine
      */
-
+    @Deprecated
     public int getLine() {
         return bufline[bufpos];
     }
 
     /**
-     * Get token end column number.
+     * @return get token end column number.
      */
     public int getEndColumn() {
         return bufcolumn[bufpos];
     }
 
     /**
-     * Get token end line number.
+     * @return get token end line number.
      */
     public int getEndLine() {
         return bufline[bufpos];
     }
 
     /**
-     * Get token beginning column number.
+     * @return get token beginning column number.
      */
     public int getBeginColumn() {
         return bufcolumn[tokenBegin];
     }
 
     /**
-     * Get token beginning line number.
+     * @return get token beginning line number.
      */
     public int getBeginLine() {
         return bufline[tokenBegin];
     }
 
     /**
      * Backup a number of characters.
+     * @param amount
      */
     public void backup(int amount) {
 
@@ -286,7 +293,11 @@ public void backup(int amount) {
     }
 
     /**
-     * Constructor.
+     * Constructor
+     * @param dstream
+     * @param startline
+     * @param startcolumn
+     * @param buffersize
      */
     public SimpleCharStream(Provider dstream, int startline,
             int startcolumn, int buffersize) {
@@ -309,22 +320,30 @@ public SimpleCharStream(Provider dstream, int startline,
     }
 
     /**
-     * Constructor.
+     * Constructor
+     * @param dstream
+     * @param startline
+     * @param startcolumn
      */
     public SimpleCharStream(Provider dstream, int startline,
             int startcolumn) {
         this(dstream, startline, startcolumn, 4096);
     }
 
     /**
-     * Constructor.
+     * Constructor
+     * @param dstream
      */
     public SimpleCharStream(Provider dstream) {
         this(dstream, 1, 1, 4096);
     }
 
     /**
      * Reinitialise.
+     * @param dstream
+     * @param startline
+     * @param startcolumn
+     * @param buffersize
      */
     public void ReInit(Provider dstream, int startline,
             int startcolumn, int buffersize) {
@@ -352,21 +371,25 @@ public void ReInit(Provider dstream, int startline,
 
     /**
      * Reinitialise.
+     * @param dstream
+     * @param startline
+     * @param startcolumn
      */
     public void ReInit(Provider dstream, int startline,
             int startcolumn) {
         ReInit(dstream, startline, startcolumn, 4096);
     }
 
-    /**
-     * Reinitialise.
-     */
+   /**
+    * Reinitialise.
+    * @param dstream
+    */
     public void ReInit(Provider dstream) {
         ReInit(dstream, 1, 1, 4096);
     }
 
     /**
-     * Get token literal value.
+     * @return get token literal value.
      */
     public String GetImage() {
         if (isStringProvider) {
@@ -388,7 +411,8 @@ public String GetImage() {
     }
 
     /**
-     * Get the suffix.
+     * @param len
+     * @return get the suffix.
      */
     public char[] GetSuffix(int len) {
 
@@ -426,9 +450,11 @@ public void Done() {
 
     /**
      * Method to adjust line and column numbers for the start of a token.
+     * @param newLine
+     * @param newCol
      */
-    @SuppressWarnings("checkstyle:parameterassignment")
     public void adjustBeginLineColumn(int newLine, int newCol) {
+        int nl = newLine;
         int start = tokenBegin;
         int len;
 
@@ -445,22 +471,22 @@ public void adjustBeginLineColumn(int newLine, int newCol) {
         int columnDiff = 0;
 
         while (i < len && bufline[j = start % bufsize] == bufline[k = ++start % bufsize]) {
-            bufline[j] = newLine;
+            bufline[j] = nl;
             nextColDiff = columnDiff + bufcolumn[k] - bufcolumn[j];
             bufcolumn[j] = newCol + columnDiff;
             columnDiff = nextColDiff;
             i++;
         }
 
         if (i < len) {
-            bufline[j] = newLine++;
+            bufline[j] = nl++;
             bufcolumn[j] = newCol + columnDiff;
 
             while (i++ < len) {
                 if (bufline[j = start % bufsize] != bufline[++start % bufsize]) {
-                    bufline[j] = newLine++;
+                    bufline[j] = nl++;
                 } else {
-                    bufline[j] = newLine;
+                    bufline[j] = nl;
                 }
             }
         }

src/main/java/net/sf/jsqlparser/parser/feature/Feature.java

@@ -33,6 +33,7 @@
 import net.sf.jsqlparser.statement.create.procedure.CreateProcedure;
 import net.sf.jsqlparser.statement.create.schema.CreateSchema;
 import net.sf.jsqlparser.statement.create.sequence.CreateSequence;
+import net.sf.jsqlparser.statement.create.synonym.CreateSynonym;
 import net.sf.jsqlparser.statement.create.table.CreateTable;
 import net.sf.jsqlparser.statement.create.view.AlterView;
 import net.sf.jsqlparser.statement.create.view.CreateView;

src/main/java/net/sf/jsqlparser/schema/Column.java

@@ -43,23 +43,23 @@ public Column(String columnName) {
       * Retrieve the information regarding the {@code Table} this {@code Column} does
       * belong to, if any can be inferred.
       * <p>
--     * The inference is based only on local information, and not on the whole SQL command.
--     * For example, consider the following query:
--     * <blockquote><pre>
--     *  SELECT x FROM Foo
--     * </pre></blockquote>
--     * Given the {@code Column} called {@code x}, this method would return {@code null},
--     * and not the info about the table {@code Foo}.
--     * On the other hand, consider:
--     * <blockquote><pre>
--     *  SELECT t.x FROM Foo t
--     * </pre></blockquote>
--     * Here, we will get a {@code Table} object for a table called {@code t}.
--     * But because the inference is local, such object will not know that {@code t} is
--     * just an alias for {@code Foo}.
+      * The inference is based only on local information, and not on the whole SQL command.
+      * For example, consider the following query:
+      * <blockquote><pre>
+      *  SELECT x FROM Foo
+      * </pre></blockquote>
+      * Given the {@code Column} called {@code x}, this method would return {@code null},
+      * and not the info about the table {@code Foo}.
+      * On the other hand, consider:
+      * <blockquote><pre>
+      *  SELECT t.x FROM Foo t
+      * </pre></blockquote>
+      * Here, we will get a {@code Table} object for a table called {@code t}.
+      * But because the inference is local, such object will not know that {@code t} is
+      * just an alias for {@code Foo}.
       *
--     * @return an instance of {@link net.sf.jsqlparser.schema.Table} representing the
--     *          table this column does belong to, if it can be inferred. Can be {@code null}.
+      * @return an instance of {@link net.sf.jsqlparser.schema.Table} representing the
+      *          table this column does belong to, if it can be inferred. Can be {@code null}.
       */
     public Table getTable() {
         return table;