Abstract toString into AbstractNode, deprecate the implementation

Log that the default implementation will be removed

pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNode.java

@@ -130,14 +130,12 @@ public abstract class AbstractApexNode<T extends AstNode> extends AbstractNode i
         }
     }
 
-    @Override
+
-    public String toString() {
-        return getXPathNodeName();
-    }
 
 
     @Override
     public final String getXPathNodeName() {
+        new ASTMapEntryNode(null).toString();
         return this.getClass().getSimpleName().replaceFirst("^AST", "");
     }
 

pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/AbstractNode.java

@@ -7,7 +7,7 @@ package net.sourceforge.pmd.lang.ast;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
-
+import java.util.logging.Logger;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
@@ -18,12 +18,16 @@ import org.jaxen.JaxenException;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
+import net.sourceforge.pmd.PMDVersion;
 import net.sourceforge.pmd.lang.ast.xpath.Attribute;
 import net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator;
 import net.sourceforge.pmd.lang.dfa.DataFlowNode;
 
 public abstract class AbstractNode implements Node {
 
+    private static final Logger LOG = Logger.getLogger(AbstractNode.class.getName());
+
+
     protected Node parent;
     protected Node[] children;
     protected int childIndex;
@@ -448,6 +452,23 @@ public abstract class AbstractNode implements Node {
      */
     @Override
     public String getXPathNodeName() {
+        LOG.warning("getXPathNodeName should be overriden in classes derived from AbstractNode. " +
+                            "The implementation is provided for compatibility with existing implementors," +
+                            "but could be declared abstract as soon as release " + PMDVersion.getNextMajorRelease()
+                            + ".");
         return toString();
     }
+
+
+    /**
+     * {@inheritDoc}
+     *
+     * @deprecated The equivalence between toString and a node's name could be broken as soon as release 7.0.0.
+     *  Use getXPathNodeName for that purpose. The use for debugging purposes is not deprecated.
+     */
+    @Deprecated
+    @Override
+    public String toString() {
+        return getXPathNodeName();
+    }
 }

pmd-core/src/test/java/net/sourceforge/pmd/jaxen/MatchesFunctionTest.java

@@ -26,6 +26,7 @@ public class MatchesFunctionTest {
             super(1);
         }
 
+        @Deprecated
         @Override
         public String toString() {
             return "MyNode";

pmd-core/src/test/java/net/sourceforge/pmd/lang/ast/DummyNode.java

@@ -9,6 +9,7 @@ public class DummyNode extends AbstractNode {
         super(id);
     }
 
+    @Deprecated
     @Override
     public String toString() {
         return "dummyNode";

pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/AbstractJavaNode.java

@@ -78,10 +78,7 @@ public abstract class AbstractJavaNode extends AbstractNode implements JavaNode
         return comment;
     }
 
-    @Override
+
-    public String toString() {
-        return getXPathNodeName();
-    }
 
     @Override
     public final String getXPathNodeName() {

pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/Comment.java

@@ -23,6 +23,7 @@ public abstract class Comment extends AbstractNode {
         }
     }
 
+    @Deprecated
     public String toString() {
         return getImage();
     }

pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavadocElement.java

@@ -21,10 +21,7 @@ public class JavadocElement extends AbstractNode {
         return tag;
     }
 
-    @Override
+
-    public String toString() {
-        return getXPathNodeName();
-    }
 
 
     @Override

pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/ast/AbstractEcmascriptNode.java

@@ -68,10 +68,7 @@ public abstract class AbstractEcmascriptNode<T extends AstNode> extends Abstract
         return node.hasSideEffects();
     }
 
-    @Override
+
-    public String toString() {
-        return getXPathNodeName();
-    }
 
 
     @Override

pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/ast/AbstractJspNode.java

@@ -56,9 +56,7 @@ public abstract class AbstractJspNode extends AbstractNode implements JspNode {
         return data;
     }
 
-    public String toString() {
+
-        return getXPathNodeName();
-    }
 
 
     @Override

pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/AbstractPLSQLNode.java

@@ -77,9 +77,7 @@ public abstract class AbstractPLSQLNode extends net.sourceforge.pmd.lang.ast.Abs
      * otherwise overriding toString() is probably all you need to do.
      */
 
-    public String toString() {
+
-        return getXPathNodeName();
-    }
 
     public String toString(String prefix) {
         return prefix + toString();

pmd-test/src/main/java/net/sourceforge/pmd/test/lang/ast/DummyNode.java

@@ -11,6 +11,7 @@ public class DummyNode extends AbstractNode {
         super(id);
     }
 
+    @Deprecated
     @Override
     public String toString() {
         return "dummyNode";

pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/ast/AbstractVFNode.java

@@ -56,9 +56,7 @@ public abstract class AbstractVFNode extends AbstractNode implements VfNode {
         return data;
     }
 
-    public String toString() {
+
-        return getXPathNodeName();
-    }
 
 
     @Override

pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/ASTDirective.java

@@ -81,6 +81,7 @@ public class ASTDirective extends AbstractVmNode {
     /**
      * @since 1.5
      */
+    @Deprecated
     @Override
     public String toString() {
         return new ToStringBuilder(this).appendSuper(super.toString()).append("directiveName", getDirectiveName())

pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/AbstractVmNode.java

@@ -134,9 +134,7 @@ public class AbstractVmNode extends AbstractNode implements VmNode {
      * otherwise overriding toString() is probably all you need to do.
      */
 
-    public String toString() {
+
-        return getXPathNodeName();
-    }
 
     /**
      * @param prefix