Merge pull request #3069 from oowekyala:xml-deprecate-java-rules

[xml] Deprecate xml base rule classes #3069

docs/pages/release_notes.md

@@ -51,6 +51,12 @@ This is a {{ site.pmd.release_type }} release.
 
 ### API Changes
 
+#### Deprecated API
+
+*   {% jdoc xml::lang.xml.rule.AbstractDomXmlRule %}
+*   {% jdoc xml::lang.wsdl.rule.AbstractWsdlRule %}
+*   A few methods of {% jdoc xml::lang.xml.rule.AbstractXmlRule %}
+
 #### Experimental APIs
 
 *   The method {% jdoc !!core::lang.ast.GenericToken#getKind() %} has been added as experimental. This

pmd-xml/src/main/java/net/sourceforge/pmd/lang/wsdl/rule/AbstractWsdlRule.java

@@ -10,7 +10,10 @@ import net.sourceforge.pmd.lang.xml.rule.AbstractXmlRule;
 
 /**
  * Created by bernardo-macedo on 24.06.15.
+ *
+ * @deprecated Extend {@link AbstractXmlRule}
  */
+@Deprecated
 public class AbstractWsdlRule extends AbstractXmlRule {
 
     public AbstractWsdlRule() {

pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/AbstractDomXmlRule.java

@@ -25,7 +25,10 @@ import net.sourceforge.pmd.lang.xml.ast.XmlNode;
  * This is a base class for XML Java bases rules that which to visit the nodes
  * using the DOM. Subclasses should override the DOM appropriate method and can
  * call <code>super</code> to visit children.
+ *
+ * @deprecated Not very useful, use XPath rules.
  */
+@Deprecated
 public class AbstractDomXmlRule extends AbstractXmlRule {
 
     @Override

pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/AbstractXmlRule.java

@@ -70,6 +70,8 @@ public class AbstractXmlRule extends AbstractRule implements ImmutableLanguage {
         visitAll(nodes, ctx);
     }
 
+    /** @deprecated Not useful, will be removed in PMD 7. */
+    @Deprecated
     protected void visitAll(List<? extends Node> nodes, RuleContext ctx) {
         for (Object element : nodes) {
             if (element instanceof XmlNode) {
@@ -78,6 +80,8 @@ public class AbstractXmlRule extends AbstractRule implements ImmutableLanguage {
         }
     }
 
+    /** @deprecated Not useful, will be removed in PMD 7. */
+    @Deprecated
     protected void visit(XmlNode node, RuleContext ctx) {
         final int numChildren = node.getNumChildren();
         for (int i = 0; i < numChildren; i++) {