Merge pull request #3980 from adangel:deprecate-ant-formatter

[core] Internalize some methods in Ant Formatter #3980
pmd · May 28, 2022 · 09c1abb · 09c1abb
2 parents ede4c6d + 4bc1352
commit 09c1abb
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md
@@ -85,6 +85,7 @@ ruleset. Use the new rule {% rule java/codestyle/UnnecessarySemicolon %} instead
     * [#1445](https://github.com/pmd/pmd/issues/1445): \[core] Allow CLI to take globs as parameters
 * core
     * [#2352](https://github.com/pmd/pmd/issues/2352): \[core] Deprecate \<lang\>-\<ruleset\> hyphen notation for ruleset references
+    * [#3787](https://github.com/pmd/pmd/issues/3787): \[core] Internalize some methods in Ant Formatter
     * [#3835](https://github.com/pmd/pmd/issues/3835): \[core] Deprecate system properties of CPDCommandLineInterface
     * [#3942](https://github.com/pmd/pmd/issues/3942): \[core] common-io path traversal vulnerability (CVE-2021-29425)
 * cs (c#)
@@ -140,6 +141,9 @@ You can identify them with the `@InternalApi` annotation. You'll also get a depr
 {% jdoc !!core::cpd.CPD#run(java.lang.String...) %} or {% jdoc !!core::cpd.CPD#main(java.lang.String[]) %}
 should be used.
 - Several members of {% jdoc test::cli.BaseCPDCLITest %} have been deprecated with replacements.
+- The methods {% jdoc !!core::ant.Formatter#start(java.lang.String) %},
+{% jdoc !!core::ant.Formatter#end(net.sourceforge.pmd.Report) %}, {% jdoc !!core::ant.Formatter#getRenderer() %},
+and {% jdoc !!core::ant.Formatter#isNoOutputSupplied() %} have been internalized.
 
 ### External Contributions
 

diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/ant/Formatter.java b/pmd-core/src/main/java/net/sourceforge/pmd/ant/Formatter.java
@@ -61,10 +61,14 @@ public void addConfiguredParam(Parameter parameter) {
         this.parameters.add(parameter);
     }
 
+    @Deprecated
+    @InternalApi
     public Renderer getRenderer() {
         return renderer;
     }
 
+    @Deprecated
+    @InternalApi
     public void start(String baseDir) {
 
         Properties properties = createProperties();
@@ -111,6 +115,8 @@ public void start(String baseDir) {
         }
     }
 
+    @Deprecated
+    @InternalApi
     public void end(Report errorReport) {
         try {
             renderer.renderFileReport(errorReport);
@@ -125,6 +131,8 @@ public void end(Report errorReport) {
         }
     }
 
+    @Deprecated
+    @InternalApi
     public boolean isNoOutputSupplied() {
         return toFile == null && !toConsole;
     }
@@ -233,6 +241,7 @@ private static String getNativeConsoleEncoding() {
         return null;
     }
 
+    @Deprecated
     @InternalApi
     public Renderer toRenderer(final Project project, List<String> inputPaths) {
         this.start(project.getBaseDir().toString());