[core] Consolidate @InternalApi classes

docs/pages/release_notes.md

@@ -154,6 +154,55 @@ in the Migration Guide.
 
 #### API Changes
 
+**Internalized classes and interfaces and methods**
+
+The following classes/methods have been marked as @<!-- -->InternalApi before and are now moved into a `internal`
+package or made (package) private and are not accessible anymore.
+
+* pmd-core
+  * {%jdoc core::cache.internal.AbstractAnalysisCache %} (now package private)
+  * {%jdoc core::cache.internal.AnalysisCache %}
+  * {%jdoc core::cache.internal.AnalysisCacheListener %}
+  * {%jdoc core::cache.internal.AnalysisResult %}
+  * {%jdoc core::cache.internal.CachedRuleMapper %} (now package private)
+  * {%jdoc core::cache.internal.CachedRuleViolation %} (now package private)
+  * {%jdoc core::cache.internal.ChecksumAware %}
+  * {%jdoc core::cache.internal.FileAnalysisCache %}
+  * {%jdoc core::cache.internal.NoopAnalysisCache %}
+  * {%jdoc core::util.internal.ResourceLoader %}
+  * {%jdoc !!core::cpd.Tokens#Tokens() %} (the constructor is now package private)
+  * {%jdoc core::lang.rule.RuleTargetSelector %} - method `isRuleChain()` has been removed. It was internal API before.
+  * {%jdoc !!core::renderers.AbstractAccumulatingRenderer#renderFileReport(Report) %} - this method is now final
+    and can't be overridden anymore.
+  * {%jdoc core::Report %} - the constructor as well as the methods `addRuleViolation`, `addConfigError`, `addError`
+    are now private and cannot be accessed anymore.
+  * {%jdoc core::RuleContext %}
+    * Method `getRule()` is now package private
+    * Method `create(FileAnalysisListener listener, Rule rule)` is removed
+* pmd-ant
+  * {%jdoc ant::ant.Formatter %}
+    * The method `getRenderer()` has been removed.
+    * The method `start(String)` is private now and not accessible anymore.
+    * The method `end(Report)` has been removed.
+    * The method `isNoOutputSupplied()` is now package private and not accessible anymore.
+    * The method `newListener(Project)` is now package private and not accessible anymore.
+  * {%jdoc ant::ant.PMDTask %}
+    * The method `getRelativizeRoots()` has been removed.
+* pmd-apex
+  * {%jdoc apex::ast.ApexNode %}: Method `getNode()` has been removed - it was deprecated before.
+    It gave access to the wrapped Jorje node and was thus internal API.
+  * {%jdoc apex::ast.AbstractApexNode %}: Method `getNode()` is now package private and not accessible anymore.
+  * {%jdoc !!apex::multifile.ApexMultifileAnalysis#ApexMultifileAnalysis(apex::ApexLanguageProperties) } (the constructor is now package private)
+  * {%jdoc apex::rule.design.AbstractNcssCountRule %} (now package private)
+  * {%jdoc apex::rule.bestpractices.AbstractApexUnitTestRule %} (moved from package `net.sourceforge.pmd.apex.rule`, now package private)
+
+**Newly internal classes, interfaces and methods**
+
+The following classes/methods are for now considered being internal API. Its usage should
+be avoided.
+
+* {%jdoc !!core::lang.LanguageProcessor.AnalysisTask#withFiles(java.util.List) %}
+
 **Removed classes and methods (previously deprecated)**
 
 The following previously deprecated classes have been removed:
@@ -181,6 +230,9 @@ The following previously deprecated classes have been removed:
 
 **Renamed classes, interfaces**
 
+* pmd-core
+  * {%jdoc core::util.log.PmdReporter %} - has been renamed from `net.sourceforge.pmd.util.log.MessageReporter`
+
 * pmd-java
   * The interface `AccessNode` has been renamed to {% jdoc java::lang.ast.ModifierOwner %}. This is only relevant
     for Java rules, which use that type directly e.g. through downcasting.

pmd-ant/src/main/java/net/sourceforge/pmd/ant/Formatter.java

@@ -26,8 +26,6 @@
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.types.Parameter;
 
-import net.sourceforge.pmd.Report;
-import net.sourceforge.pmd.annotation.InternalApi;
 import net.sourceforge.pmd.internal.util.IOUtil;
 import net.sourceforge.pmd.lang.document.TextFile;
 import net.sourceforge.pmd.renderers.Renderer;
@@ -37,7 +35,6 @@
 import net.sourceforge.pmd.reporting.GlobalAnalysisListener;
 import net.sourceforge.pmd.reporting.ListenerInitializer;
 
-@InternalApi
 public class Formatter {
 
     private File toFile;
@@ -68,15 +65,7 @@ public void addConfiguredParam(Parameter parameter) {
         this.parameters.add(parameter);
     }
 
-    @Deprecated
-    @InternalApi
-    public Renderer getRenderer() {
-        return renderer;
-    }
-
-    @Deprecated
-    @InternalApi
-    public void start(String baseDir) {
+    private void start(String baseDir) {
 
         Properties properties = createProperties();
 
@@ -122,25 +111,7 @@ public void start(String baseDir) {
         }
     }
 
-    @Deprecated
-    @InternalApi
-    public void end(Report errorReport) {
-        try {
-            renderer.renderFileReport(errorReport);
-            renderer.end();
-            if (toConsole) {
-                writer.flush();
-            } else {
-                writer.close();
-            }
-        } catch (IOException ioe) {
-            throw new BuildException(ioe.getMessage(), ioe);
-        }
-    }
-
-    @Deprecated
-    @InternalApi
-    public boolean isNoOutputSupplied() {
+    boolean isNoOutputSupplied() {
         return toFile == null && !toConsole;
     }
 
@@ -248,12 +219,8 @@ private static String getNativeConsoleEncoding() {
         return null;
     }
 
-    @Deprecated
-    @InternalApi
-    public GlobalAnalysisListener newListener(Project project) throws IOException {
+    GlobalAnalysisListener newListener(Project project) throws IOException {
         start(project.getBaseDir().toString());
-        Renderer renderer = getRenderer();
-
         return new GlobalAnalysisListener() {
             final GlobalAnalysisListener listener = renderer.newListener();
 

pmd-ant/src/main/java/net/sourceforge/pmd/ant/InternalApiBridge.java

@@ -0,0 +1,28 @@
+/*
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.ant;
+
+import java.io.IOException;
+
+import org.apache.tools.ant.Project;
+
+import net.sourceforge.pmd.annotation.InternalApi;
+import net.sourceforge.pmd.reporting.GlobalAnalysisListener;
+
+/**
+ * Gives access to package private methods.
+ *
+ * @apiNote Internal API
+ */
+@InternalApi
+public final class InternalApiBridge {
+    private InternalApiBridge() {
+        // utility class
+    }
+
+    public static GlobalAnalysisListener newListener(Formatter formatter, Project project) throws IOException {
+        return formatter.newListener(project);
+    }
+}

pmd-ant/src/main/java/net/sourceforge/pmd/ant/PMDTask.java

@@ -4,7 +4,6 @@
 
 package net.sourceforge.pmd.ant;
 
-import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
@@ -15,10 +14,8 @@
 import org.apache.tools.ant.types.FileSet;
 import org.apache.tools.ant.types.Path;
 import org.apache.tools.ant.types.Reference;
-import org.apache.tools.ant.types.Resource;
 
 import net.sourceforge.pmd.RulePriority;
-import net.sourceforge.pmd.annotation.InternalApi;
 import net.sourceforge.pmd.ant.internal.PMDTaskImpl;
 
 /**
@@ -299,15 +296,4 @@ public void addRelativizePathsWith(Path relativizePathsWith) {
     public List<Path> getRelativizePathsWith() {
         return relativizePathsWith;
     }
-
-    @InternalApi
-    public List<java.nio.file.Path> getRelativizeRoots() {
-        List<java.nio.file.Path> paths = new ArrayList<>();
-        for (Path path : getRelativizePathsWith()) {
-            for (Resource resource : path) {
-                paths.add(Paths.get(resource.toString()));
-            }
-        }
-        return paths;
-    }
 }

pmd-ant/src/main/java/net/sourceforge/pmd/ant/internal/PMDTaskImpl.java

@@ -5,6 +5,7 @@
 package net.sourceforge.pmd.ant.internal;
 
 import java.nio.charset.Charset;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -16,6 +17,7 @@
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.types.FileSet;
 import org.apache.tools.ant.types.Path;
+import org.apache.tools.ant.types.Resource;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -26,6 +28,7 @@
 import net.sourceforge.pmd.RulePriority;
 import net.sourceforge.pmd.RuleSetLoader;
 import net.sourceforge.pmd.ant.Formatter;
+import net.sourceforge.pmd.ant.InternalApiBridge;
 import net.sourceforge.pmd.ant.PMDTask;
 import net.sourceforge.pmd.ant.SourceLanguage;
 import net.sourceforge.pmd.internal.Slf4jSimpleConfiguration;
@@ -54,7 +57,7 @@ public class PMDTaskImpl {
     private Project project;
 
     public PMDTaskImpl(PMDTask task) {
-        configuration.addRelativizeRoots(task.getRelativizeRoots());
+        configuration.addRelativizeRoots(getRelativizeRoots(task));
         if (task.getSuppressMarker() != null) {
             configuration.setSuppressMarker(task.getSuppressMarker());
         }
@@ -97,6 +100,17 @@ public PMDTaskImpl(PMDTask task) {
         project = task.getProject();
     }
 
+    private static List<java.nio.file.Path> getRelativizeRoots(PMDTask pmdTask) {
+        List<java.nio.file.Path> paths = new ArrayList<>();
+        for (Path path : pmdTask.getRelativizePathsWith()) {
+            for (Resource resource : path) {
+                paths.add(Paths.get(resource.toString()));
+            }
+        }
+        return paths;
+    }
+
+
     private void doTask() {
         setupClassLoader();
 
@@ -161,7 +175,7 @@ private List<String> expandRuleSetPaths(List<String> ruleSetPaths) {
             renderers.add(reportSizeListener);
             for (Formatter formatter : formatters) {
                 project.log("Sending a report to " + formatter, Project.MSG_VERBOSE);
-                renderers.add(formatter.newListener(project));
+                renderers.add(InternalApiBridge.newListener(formatter, project));
             }
             return GlobalAnalysisListener.tee(renderers);
         } catch (Exception e) {

pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexLanguageProcessor.java

@@ -8,6 +8,7 @@
 
 import net.sourceforge.pmd.lang.LanguageVersionHandler;
 import net.sourceforge.pmd.lang.apex.multifile.ApexMultifileAnalysis;
+import net.sourceforge.pmd.lang.apex.multifile.InternalApiBridge;
 import net.sourceforge.pmd.lang.impl.BatchLanguageProcessor;
 
 public class ApexLanguageProcessor
@@ -18,7 +19,7 @@ public class ApexLanguageProcessor
 
     ApexLanguageProcessor(ApexLanguageProperties bundle) {
         super(bundle);
-        this.multifileAnalysis = new ApexMultifileAnalysis(bundle);
+        this.multifileAnalysis = InternalApiBridge.createApexMultiFileAnalysis(bundle);
         this.services = new ApexLanguageHandler();
     }
 

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

@@ -42,6 +42,6 @@ void closeNode(TextDocument document) {
 
     @Override
     public boolean hasRealLoc() {
-        return super.hasRealLoc() && !Objects.equals(node.getLoc(), getParent().getNode().getLoc());
+        return super.hasRealLoc() && !Objects.equals(node.getLoc(), ((AbstractApexNode<?>) getParent()).getNode().getLoc());
     }
 }

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

@@ -6,7 +6,6 @@
 
 import org.checkerframework.checker.nullness.qual.NonNull;
 
-import net.sourceforge.pmd.annotation.InternalApi;
 import net.sourceforge.pmd.lang.ast.AstVisitor;
 import net.sourceforge.pmd.lang.ast.FileAnalysisException;
 import net.sourceforge.pmd.lang.ast.impl.AbstractNode;
@@ -89,10 +88,7 @@ protected void setRegion(TextRegion region) {
         this.region = region;
     }
 
-    @Deprecated
-    @InternalApi
-    @Override
-    public T getNode() {
+    T getNode() {
         return node;
     }
 

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

@@ -14,8 +14,7 @@
 
 /**
  * Root interface implemented by all Apex nodes. Apex nodes wrap a tree
- * obtained from an external parser (Jorje). The underlying AST node is
- * available with {@link #getNode()}.
+ * obtained from an external parser (Jorje).
  *
  * @param <T> Type of the underlying Jorje node
  */
@@ -33,16 +32,6 @@ default Object jjtAccept(ApexParserVisitor visitor, Object data) {
     }
 
 
-    /**
-     * Get the underlying AST node.
-     * @deprecated the underlying AST node should not be available outside of the AST node.
-     *      If information is needed from the underlying node, then PMD's AST node need to expose
-     *      this information.
-     */
-    @Deprecated
-    T getNode();
-
-
     boolean hasRealLoc();
 
 

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

@@ -4,7 +4,6 @@
 
 package net.sourceforge.pmd.lang.apex.ast;
 
-import net.sourceforge.pmd.annotation.InternalApi;
 import net.sourceforge.pmd.lang.apex.ApexJorjeLogging;
 import net.sourceforge.pmd.lang.apex.ApexLanguageProcessor;
 import net.sourceforge.pmd.lang.ast.ParseException;
@@ -14,7 +13,6 @@
 import apex.jorje.data.Locations;
 import apex.jorje.semantic.ast.compilation.Compilation;
 
-@InternalApi
 public final class ApexParser implements Parser {
 
     public ApexParser() {

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

@@ -328,7 +328,7 @@ private void closeTree(AbstractApexNode<?> node) {
         }
     }
 
-    private boolean containsComments(ASTCommentContainer<?> commentContainer) {
+    private boolean containsComments(AbstractApexCommentContainerNode<?> commentContainer) {
         Location loc = commentContainer.getNode().getLoc();
         if (!Locations.isReal(loc)) {
             // Synthetic nodes don't have a location and can't have comments

pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileAnalysis.java

@@ -16,7 +16,6 @@
 import org.slf4j.LoggerFactory;
 
 import net.sourceforge.pmd.annotation.Experimental;
-import net.sourceforge.pmd.annotation.InternalApi;
 import net.sourceforge.pmd.lang.apex.ApexLanguageProcessor;
 import net.sourceforge.pmd.lang.apex.ApexLanguageProperties;
 
@@ -52,8 +51,7 @@ public final class ApexMultifileAnalysis {
     }
 
 
-    @InternalApi
-    public ApexMultifileAnalysis(ApexLanguageProperties properties) {
+    ApexMultifileAnalysis(ApexLanguageProperties properties) {
         String rootDir = properties.getProperty(ApexLanguageProperties.MULTIFILE_DIRECTORY);
         LOG.debug("MultiFile Analysis created for {}", rootDir);