From 1c9a73426c9f16829ee447dcd3b717b4a57fa849 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Wed, 1 May 2019 11:29:43 +0200 Subject: [PATCH] deprecate: DumpFacade will be removed in PMD 7 Refs #1801 --- docs/pages/release_notes.md | 17 +++++++++++++++++ .../pmd/lang/apex/ast/DumpFacade.java | 5 +++++ .../pmd/lang/java/ast/DumpFacade.java | 5 +++++ .../pmd/lang/ecmascript/ast/DumpFacade.java | 5 +++++ .../pmd/lang/jsp/ast/DumpFacade.java | 5 +++++ .../pmd/lang/plsql/ast/DumpFacade.java | 5 +++++ .../sourceforge/pmd/lang/vf/ast/DumpFacade.java | 5 +++++ .../pmd/lang/vm/ast/AbstractVmNode.java | 2 ++ .../pmd/lang/xml/ast/DumpFacade.java | 5 +++++ 9 files changed, 54 insertions(+) diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index 2178f6ed15..1760022561 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -18,6 +18,23 @@ This is a {{ site.pmd.release_type }} release. ### API Changes +#### Deprecated APIs + +##### For removal + +* The `DumpFacades` in all languages, that could be used to transform a AST into a textual representation, + will be removed with PMD 7. The rule designer is a better way to inspect nodes. + * {% jdoc !q!apex::lang.apex.ast.DumpFacade %} + * {% jdoc !q!java::lang.java.ast.DumpFacade %} + * {% jdoc !q!javascript::lang.ecmascript.ast.DumpFacade %} + * {% jdoc !q!jsp::lang.jsp.ast.DumpFacade %} + * {% jdoc !q!plsql::lang.plsql.ast.DumpFacade %} + * {% jdoc !q!visualforce::lang.vf.ast.DumpFacade %} + * {% jdoc !q!vm::lang.vm.ast.AbstractVmNode#dump(String, boolean, Writer) %} + * {% jdoc !q!xml::lang.xml.ast.DumpFacade %} +* The method {% jdoc !c!core::lang.LanguageVersionHandler#getDumpFacade(Writer, String, boolean) %} will be + removed as well. + ### External Contributions * [#1803](https://github.com/pmd/pmd/pull/1803): \[dart] \[cpd] Dart escape sequences - [Maikel Steneker](https://github.com/maikelsteneker) diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java index f4b0e4efb9..616ce31520 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java @@ -12,6 +12,11 @@ import java.util.List; import net.sourceforge.pmd.util.StringUtil; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade { private PrintWriter writer; diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/DumpFacade.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/DumpFacade.java index 8d6917d5a5..f0266acee4 100644 --- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/DumpFacade.java +++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/DumpFacade.java @@ -10,6 +10,11 @@ import java.io.Writer; import java.util.ArrayList; import java.util.List; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade extends JavaParserVisitorAdapter { private PrintWriter writer; diff --git a/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/ast/DumpFacade.java b/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/ast/DumpFacade.java index 4c2910248b..11a862d54c 100644 --- a/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/ast/DumpFacade.java +++ b/pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/ast/DumpFacade.java @@ -12,6 +12,11 @@ import java.util.List; import net.sourceforge.pmd.util.StringUtil; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade { private PrintWriter writer; diff --git a/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/ast/DumpFacade.java b/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/ast/DumpFacade.java index e1381a9626..ee6c78b206 100644 --- a/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/ast/DumpFacade.java +++ b/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/ast/DumpFacade.java @@ -12,6 +12,11 @@ import java.util.List; import net.sourceforge.pmd.lang.ast.Node; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade extends JspParserVisitorAdapter { private PrintWriter writer; diff --git a/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/DumpFacade.java b/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/DumpFacade.java index d6be0486fe..e53532b1eb 100644 --- a/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/DumpFacade.java +++ b/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/DumpFacade.java @@ -10,6 +10,11 @@ import java.io.Writer; import java.util.ArrayList; import java.util.List; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade extends PLSQLParserVisitorAdapter { private PrintWriter writer; diff --git a/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/ast/DumpFacade.java b/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/ast/DumpFacade.java index 704ae8e1a3..7430f77b1c 100644 --- a/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/ast/DumpFacade.java +++ b/pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/ast/DumpFacade.java @@ -12,6 +12,11 @@ import java.util.List; import net.sourceforge.pmd.lang.ast.Node; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade extends VfParserVisitorAdapter { private PrintWriter writer; diff --git a/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/AbstractVmNode.java b/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/AbstractVmNode.java index a640db2813..9e552aac82 100644 --- a/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/AbstractVmNode.java +++ b/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/ast/AbstractVmNode.java @@ -151,7 +151,9 @@ public class AbstractVmNode extends AbstractNode implements VmNode { * children. * * @param prefix + * @deprecated This method will be removed with PMD 7. The rule designer is a better way to inspect nodes. */ + @Deprecated public void dump(final String prefix, final boolean recurse, final Writer writer) { final PrintWriter printWriter = writer instanceof PrintWriter ? (PrintWriter) writer : new PrintWriter(writer); printWriter.println(toString(prefix)); diff --git a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/DumpFacade.java b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/DumpFacade.java index 888995fe9b..76ebac8655 100644 --- a/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/DumpFacade.java +++ b/pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/ast/DumpFacade.java @@ -14,6 +14,11 @@ import java.util.List; import net.sourceforge.pmd.lang.ast.xpath.Attribute; import net.sourceforge.pmd.util.StringUtil; +/** + * + * @deprecated This class will be removed with PMD 7. The rule designer is a better way to inspect nodes. + */ +@Deprecated public class DumpFacade { private PrintWriter writer;