From 01c283ce00bb57d3ebbe1175cc0375be3cbb7e3c Mon Sep 17 00:00:00 2001
From: John Teng <john.teng97@gmail.com>
Date: Fri, 15 May 2020 14:19:07 -0400
Subject: [PATCH] Added deprecated tags to code and bestpractices ruleset,
 updated quickstart ruleset

---
 .../AbstractPositionLiteralsFirstInComparisons.java    |  1 +
 ...nLiteralsFirstInCaseInsensitiveComparisonsRule.java |  1 +
 .../PositionLiteralsFirstInComparisonsRule.java        |  1 +
 .../src/main/resources/category/java/bestpractices.xml | 10 ++++++----
 .../src/main/resources/rulesets/java/quickstart.xml    |  2 +-
 5 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/AbstractPositionLiteralsFirstInComparisons.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/AbstractPositionLiteralsFirstInComparisons.java
index 3b09462725..7e9d5f347f 100644
--- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/AbstractPositionLiteralsFirstInComparisons.java
+++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/AbstractPositionLiteralsFirstInComparisons.java
@@ -20,6 +20,7 @@ import net.sourceforge.pmd.lang.java.ast.ASTPrimarySuffix;
 import net.sourceforge.pmd.lang.java.ast.JavaNode;
 import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule;
 
+@Deprecated
 class AbstractPositionLiteralsFirstInComparisons extends AbstractJavaRule {
 
     private final String equalsImage;
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInCaseInsensitiveComparisonsRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInCaseInsensitiveComparisonsRule.java
index 1c84769c01..2ddcfd813f 100644
--- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInCaseInsensitiveComparisonsRule.java
+++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInCaseInsensitiveComparisonsRule.java
@@ -4,6 +4,7 @@
 
 package net.sourceforge.pmd.lang.java.rule.bestpractices;
 
+@Deprecated
 public class PositionLiteralsFirstInCaseInsensitiveComparisonsRule extends AbstractPositionLiteralsFirstInComparisons {
 
     public PositionLiteralsFirstInCaseInsensitiveComparisonsRule() {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInComparisonsRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInComparisonsRule.java
index 2b9edd12c4..2b5a5c6d32 100644
--- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInComparisonsRule.java
+++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/PositionLiteralsFirstInComparisonsRule.java
@@ -4,6 +4,7 @@
 
 package net.sourceforge.pmd.lang.java.rule.bestpractices;
 
+@Deprecated
 public class PositionLiteralsFirstInComparisonsRule extends AbstractPositionLiteralsFirstInComparisons {
 
     public PositionLiteralsFirstInComparisonsRule() {
diff --git a/pmd-java/src/main/resources/category/java/bestpractices.xml b/pmd-java/src/main/resources/category/java/bestpractices.xml
index 68fefdc82a..84173e58f9 100644
--- a/pmd-java/src/main/resources/category/java/bestpractices.xml
+++ b/pmd-java/src/main/resources/category/java/bestpractices.xml
@@ -1051,10 +1051,11 @@ String name,
           since="5.1"
           message="Position literals first in String comparisons for EqualsIgnoreCase"
           class="net.sourceforge.pmd.lang.java.rule.bestpractices.PositionLiteralsFirstInCaseInsensitiveComparisonsRule"
-          externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_bestpractices.html#positionliteralsfirstincaseinsensitivecomparisons">
+          externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_bestpractices.html#positionliteralsfirstincaseinsensitivecomparisons"
+          deprecated="true">
         <description>
 Position literals first in comparisons, if the second argument is null then NullPointerExceptions
-can be avoided, they will just return false.
+can be avoided, they will just return false. This rule is replaced by the more general LiteralsFirstInComparisons rule.
         </description>
         <priority>3</priority>
         <example>
@@ -1073,10 +1074,11 @@ class Foo {
           since="3.3"
           message="Position literals first in String comparisons"
           class="net.sourceforge.pmd.lang.java.rule.bestpractices.PositionLiteralsFirstInComparisonsRule"
-          externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_bestpractices.html#positionliteralsfirstincomparisons">
+          externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_bestpractices.html#positionliteralsfirstincomparisons"
+          deprecated="true">
         <description>
 Position literals first in comparisons, if the second argument is null then NullPointerExceptions
-can be avoided, they will just return false.
+can be avoided, they will just return false.  This rule is replaced by the more general LiteralsFirstInComparisons rule.
         </description>
         <priority>3</priority>
         <example>
diff --git a/pmd-java/src/main/resources/rulesets/java/quickstart.xml b/pmd-java/src/main/resources/rulesets/java/quickstart.xml
index df114a123d..0b21d61360 100644
--- a/pmd-java/src/main/resources/rulesets/java/quickstart.xml
+++ b/pmd-java/src/main/resources/rulesets/java/quickstart.xml
@@ -51,7 +51,7 @@
     <rule ref="category/java/bestpractices.xml/UseAssertSameInsteadOfAssertTrue"/>
     <rule ref="category/java/bestpractices.xml/UseAssertTrueInsteadOfAssertEquals"/>
     <rule ref="category/java/bestpractices.xml/UseCollectionIsEmpty"/>
-    <!-- <rule ref="category/java/bestpractices.xml/UseTryWithResources" /> -->
+    <!-- <rule ref="qqcategory/java/bestpractices.xml/UseTryWithResources" /> -->
     <!-- <rule ref="category/java/bestpractices.xml/UseVarargs" /> -->
     <!-- <rule ref="category/java/bestpractices.xml/WhileLoopWithLiteralBoolean" /> -->