Pmd clean up (#1215)

manticore-projects · web-flow · commit 537649bf28f6 · 2021-06-02T14:19:32.000+02:00
* Add PMD Annotations in order to avoid useless exceptions for the Deparsers

* Add Eclipse Formatter configuration

* Fix typo

* Replace Comments on empty methods with Class wide PMD Annotation
Do not enforce checkstyle formatting
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ Also I would like to know about needed examples or documentation stuff.
 ** API change FunctionWithCondParams production removed
 * API change in ValuesStatement: the expression list is now hold as a ItemList and not as a List<Expression>
 * support for parser modification within **parseExpression** and **parseCondExpression**
-' support for table schema for foreign keys
+* support for table schema for foreign keys
 * support for Oracle hints on **insert, update and merge**
 * support for **merge insert where** clause
 * allow **in** as schema name
diff --git a/eclipse-java-google-style.xml b/eclipse-java-google-style.xml
diff --git a/nb-configuration.xml b/nb-configuration.xml
@@ -20,5 +20,13 @@
         <com-junichi11-netbeans-changelf.use-global>false</com-junichi11-netbeans-changelf.use-global>
         <org-netbeans-modules-javascript2-requirejs.enabled>true</org-netbeans-modules-javascript2-requirejs.enabled>
         <netbeans.hint.jdkPlatform>JDK_1.8</netbeans.hint.jdkPlatform>
+        <org-netbeans-modules-editor-indent.text.xml.CodeStyle.project.expand-tabs>false</org-netbeans-modules-editor-indent.text.xml.CodeStyle.project.expand-tabs>
+        <org-netbeans-modules-editor-indent.CodeStyle.project.text-line-wrap>none</org-netbeans-modules-editor-indent.CodeStyle.project.text-line-wrap>
+        <org-netbeans-modules-editor-indent.CodeStyle.project.indent-shift-width>4</org-netbeans-modules-editor-indent.CodeStyle.project.indent-shift-width>
+        <org-netbeans-modules-editor-indent.CodeStyle.project.spaces-per-tab>4</org-netbeans-modules-editor-indent.CodeStyle.project.spaces-per-tab>
+        <org-netbeans-modules-editor-indent.CodeStyle.project.tab-size>4</org-netbeans-modules-editor-indent.CodeStyle.project.tab-size>
+        <org-netbeans-modules-editor-indent.CodeStyle.project.text-limit-width>120</org-netbeans-modules-editor-indent.CodeStyle.project.text-limit-width>
+        <org-netbeans-modules-editor-indent.CodeStyle.project.expand-tabs>true</org-netbeans-modules-editor-indent.CodeStyle.project.expand-tabs>
+        <org-netbeans-modules-editor-indent.CodeStyle.usedProfile>project</org-netbeans-modules-editor-indent.CodeStyle.usedProfile>
     </properties>
 </project-shared-configuration>
diff --git a/pmd-rules.xml b/pmd-rules.xml
@@ -110,5 +110,7 @@ under the License.
 
     <rule ref="category/java/performance.xml/BigIntegerInstantiation" />
     <rule ref="category/java/performance.xml/BooleanInstantiation" />
-
+    
+    <!-- for Codazy -->
+    <rule ref="category/java/documentation.xml/UncommentedEmptyMethodBody" />
 </ruleset>
diff --git a/pom.xml b/pom.xml
@@ -365,6 +365,13 @@
                 <artifactId>javacc-maven-plugin</artifactId>
                 <version>2.6</version>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <configuration>
+                    <configLocation>config/sun_checks.xml</configLocation>
+                </configuration>
+            </plugin>
         </plugins>
     </reporting>
 
diff --git a/src/main/java/net/sf/jsqlparser/expression/AnalyticExpression.java b/src/main/java/net/sf/jsqlparser/expression/AnalyticExpression.java
@@ -179,7 +179,7 @@ public void setIgnoreNulls(boolean ignoreNulls) {
     }
 
     @Override
-    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.ExcessiveMethodLength"})
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
     public String toString() {
         StringBuilder b = new StringBuilder();
 
diff --git a/src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java
@@ -30,7 +30,7 @@
 import net.sf.jsqlparser.statement.select.UnPivot;
 import net.sf.jsqlparser.statement.select.WithItem;
 
-@SuppressWarnings({"PMD.CyclomaticComplexity"})
+@SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.UncommentedEmptyMethodBody"})
 public class ExpressionVisitorAdapter implements ExpressionVisitor, ItemsListVisitor, PivotVisitor, SelectItemVisitor {
 
     private SelectVisitor selectVisitor;
diff --git a/src/main/java/net/sf/jsqlparser/expression/Function.java b/src/main/java/net/sf/jsqlparser/expression/Function.java
@@ -168,7 +168,7 @@ public void setKeep(KeepExpression keep) {
     }
 
     @Override
-    @SuppressWarnings({"PMD.CyclomaticComplexity"})
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
     public String toString() {
         String params;
 
diff --git a/src/main/java/net/sf/jsqlparser/expression/operators/relational/ItemsListVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/expression/operators/relational/ItemsListVisitorAdapter.java
@@ -11,6 +11,7 @@
 
 import net.sf.jsqlparser.statement.select.SubSelect;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class ItemsListVisitorAdapter implements ItemsListVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/StatementVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/StatementVisitorAdapter.java
@@ -33,6 +33,7 @@
 import net.sf.jsqlparser.statement.upsert.Upsert;
 import net.sf.jsqlparser.statement.values.ValuesStatement;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class StatementVisitorAdapter implements StatementVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/alter/AlterExpression.java b/src/main/java/net/sf/jsqlparser/statement/alter/AlterExpression.java
@@ -360,7 +360,7 @@ public void setUk(boolean uk) {
   }
 
   @Override
-  @SuppressWarnings({"PMD.CyclomaticComplexity"})
+  @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
   public String toString() {
 
     StringBuilder b = new StringBuilder();
diff --git a/src/main/java/net/sf/jsqlparser/statement/create/table/CreateTable.java b/src/main/java/net/sf/jsqlparser/statement/create/table/CreateTable.java
@@ -141,7 +141,7 @@ public void setRowMovement(RowMovement rowMovement) {
     }
 
     @Override
-    @SuppressWarnings({"PMD.CyclomaticComplexity"})
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
     public String toString() {
         String sql;
         String createOps = PlainSelect.getStringList(createOptionsStrings, false, false);
diff --git a/src/main/java/net/sf/jsqlparser/statement/insert/Insert.java b/src/main/java/net/sf/jsqlparser/statement/insert/Insert.java
@@ -207,7 +207,7 @@ public void setWithItemsList(List<WithItem> withItemsList) {
     }
 
     @Override
-    @SuppressWarnings({"PMD.CyclomaticComplexity"})
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
     public String toString() {
         StringBuilder sql = new StringBuilder();
         if (withItemsList != null && !withItemsList.isEmpty()) {
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/FromItemVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/FromItemVisitorAdapter.java
@@ -11,6 +11,7 @@
 
 import net.sf.jsqlparser.schema.Table;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class FromItemVisitorAdapter implements FromItemVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/GroupByElement.java b/src/main/java/net/sf/jsqlparser/statement/select/GroupByElement.java
@@ -55,6 +55,7 @@ public void addGroupingSet(ExpressionList list) {
     }
 
     @Override
+    @SuppressWarnings({"PMD.CyclomaticComplexity"})
     public String toString() {
         StringBuilder b = new StringBuilder();
         b.append("GROUP BY ");
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/IntoTableVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/IntoTableVisitorAdapter.java
@@ -11,6 +11,7 @@
 
 import net.sf.jsqlparser.schema.Table;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class IntoTableVisitorAdapter implements IntoTableVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/Join.java b/src/main/java/net/sf/jsqlparser/statement/select/Join.java
@@ -263,6 +263,7 @@ public boolean isWindowJoin() {
 
     /**
      * Return the "WITHIN" join window (if any)
+     * @return 
      */
     public KSQLJoinWindow getJoinWindow() {
         return joinWindow;
@@ -278,7 +279,7 @@ public void setJoinWindow(KSQLJoinWindow joinWindow) {
     }
 
     @Override
-    @SuppressWarnings({"PMD.CyclomaticComplexity"})
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
     public String toString() {
         if (isSimple() && isOuter()) {
             return "OUTER " + rightItem;
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/OrderByVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/OrderByVisitorAdapter.java
@@ -9,6 +9,7 @@
  */
 package net.sf.jsqlparser.statement.select;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class OrderByVisitorAdapter implements OrderByVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/PivotVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/PivotVisitorAdapter.java
@@ -9,6 +9,7 @@
  */
 package net.sf.jsqlparser.statement.select;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class PivotVisitorAdapter implements PivotVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/PlainSelect.java b/src/main/java/net/sf/jsqlparser/statement/select/PlainSelect.java
@@ -322,7 +322,7 @@ public void setKsqlWindow(KSQLWindow ksqlWindow) {
     }
 
     @Override
-    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.ExcessiveMethodLength"})
+    @SuppressWarnings({"PMD.CyclomaticComplexity" , "PMD.ExcessiveMethodLength", "PMD.NPathComplexity"})
     public String toString() {
         StringBuilder sql = new StringBuilder();
         if (useBrackets) {
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/Select.java b/src/main/java/net/sf/jsqlparser/statement/select/Select.java
@@ -42,6 +42,7 @@ public void setSelectBody(SelectBody body) {
     }
 
     @Override
+    @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})
     public String toString() {
         StringBuilder retval = new StringBuilder();
         if (withItemsList != null && !withItemsList.isEmpty()) {
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/SelectItemVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/SelectItemVisitorAdapter.java
@@ -9,6 +9,7 @@
  */
 package net.sf.jsqlparser.statement.select;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class SelectItemVisitorAdapter implements SelectItemVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/SelectVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/statement/select/SelectVisitorAdapter.java
@@ -11,6 +11,7 @@
 
 import net.sf.jsqlparser.statement.values.ValuesStatement;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class SelectVisitorAdapter implements SelectVisitor {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/TableFunction.java b/src/main/java/net/sf/jsqlparser/statement/select/TableFunction.java
@@ -12,6 +12,7 @@
 import net.sf.jsqlparser.expression.Alias;
 import net.sf.jsqlparser.expression.Function;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class TableFunction extends FunctionItem implements FromItem {
 
     @Override
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/ValuesList.java b/src/main/java/net/sf/jsqlparser/statement/select/ValuesList.java
@@ -19,6 +19,7 @@
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.MultiExpressionList;
 
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public class ValuesList implements FromItem {
 
     private Alias alias;
diff --git a/src/main/java/net/sf/jsqlparser/statement/select/WithItem.java b/src/main/java/net/sf/jsqlparser/statement/select/WithItem.java
@@ -60,6 +60,7 @@ public void setWithItemList(List<SelectItem> withItemList) {
     }
 
     @Override
+    @SuppressWarnings({"PMD.CyclomaticComplexity"})
     public String toString() {
         return (recursive ? "RECURSIVE " : "") + name + ((withItemList != null) ? " " + PlainSelect.
                 getStringList(withItemList, true, true) : "")
diff --git a/src/main/java/net/sf/jsqlparser/util/ConnectExpressionsVisitor.java b/src/main/java/net/sf/jsqlparser/util/ConnectExpressionsVisitor.java
@@ -21,6 +21,7 @@
  *
  * @author tw
  */
+@SuppressWarnings({"PMD.UncommentedEmptyMethodBody"})
 public abstract class ConnectExpressionsVisitor implements SelectVisitor, SelectItemVisitor {
 
     private String alias = "expr";
diff --git a/src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java b/src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/CreateTableDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/CreateTableDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/CreateViewDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/CreateViewDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/GroupByDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/GroupByDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/InsertDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/InsertDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/SelectDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/SelectDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/UpdateDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/UpdateDeParser.java
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/UpsertDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/UpsertDeParser.java
diff --git a/src/test/java/net/sf/jsqlparser/statement/select/NestedBracketsPerformanceTest.java b/src/test/java/net/sf/jsqlparser/statement/select/NestedBracketsPerformanceTest.java

Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ public void setIgnoreNulls(boolean ignoreNulls) {`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`@Override`
`182`		`- @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.ExcessiveMethodLength"})`
	`182`	`+ @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})`
`183`	`183`	`public String toString() {`
`184`	`184`	`StringBuilder b = new StringBuilder();`
`185`	`185`
Original file line number	Diff line number	Diff line change
`@@ -168,7 +168,7 @@ public void setKeep(KeepExpression keep) {`
`168`	`168`	`}`
`169`	`169`
`170`	`170`	`@Override`
`171`		`- @SuppressWarnings({"PMD.CyclomaticComplexity"})`
	`171`	`+ @SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.NPathComplexity"})`
`172`	`172`	`public String toString() {`
`173`	`173`	`String params;`
`174`	`174`