Merge pull request #156 from adangel:fix-deprecations

Cleanup and fix deprecations #156

Author: adangel

ReleaseNotes.md

@@ -20,6 +20,17 @@ This is a minor release.
 
 ### API Changes
 
+#### Deprecated for removal
+
+*   `net.sourceforge.pmd.eclipse.plugin.EclipseUtil`
+*   `net.sourceforge.pmd.eclipse.plugin.PMDPlugin.getPluginFolder()`
+*   `net.sourceforge.pmd.eclipse.runtime.cmd.BaseVisitor.isUseTaskMarker()`
+*   `net.sourceforge.pmd.eclipse.runtime.cmd.BaseVisitor.setUseTaskMarker(boolean)`
+*   `net.sourceforge.pmd.eclipse.ui.preferences.br.FilterManager`
+*   `net.sourceforge.pmd.eclipse.util.IOUtil`
+*   All classes that couldn't be instantiated because they had a private constructor only
+    are now also `final`.
+
 ### External Contributions
 
 ## 26-June-2021: 4.25.0.v20210626-0908

net.sourceforge.pmd.eclipse.plugin.test.fragment/src/main/java/test/RuleSetsExtension.java

@@ -31,6 +31,7 @@ public class RuleSetsExtension implements IRuleSetsExtension {
      * Replace the core plugin fragment with our own rulesets
      * @see net.sourceforge.pmd.eclipse.core.IRuleSetsExtension#registerRuleSets(java.util.Set)
      */
+    @Override
     public void registerRuleSets(Set<RuleSet> registeredRuleSets) {
         try {
             RuleSet ruleSet1 = getRuleSet1();
@@ -49,6 +50,7 @@ public void registerRuleSets(Set<RuleSet> registeredRuleSets) {
      * (for instance when creating a new workspace)
      * @see net.sourceforge.pmd.eclipse.core.IRuleSetsExtension#registerDefaultRuleSets(java.util.Set)
      */
+    @Override
     public void registerDefaultRuleSets(Set<RuleSet> defaultRuleSets) {
         try {
             RuleSet ruleSet1 = getRuleSet1();

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/EclipseUtils.java

@@ -142,19 +142,18 @@ public static IFile createTestSourceFile(final IProject project)
             throws JavaModelException, CoreException, IOException {
 
         // 1. Locate the test java source template
-        final InputStream is = EclipseUtils.class.getResourceAsStream("/test.template");
-
-        // 2. Copy the template inside the source directory
-        final IFile sourceFile = project.getFile("/src/Test.java");
-        if (sourceFile.exists() && sourceFile.isAccessible()) {
-            sourceFile.setContents(is, true, false, null);
-        } else {
-            sourceFile.create(is, true, null);
+        try (InputStream is = EclipseUtils.class.getResourceAsStream("/test.template")) {
+            // 2. Copy the template inside the source directory
+            final IFile sourceFile = project.getFile("/src/Test.java");
+            if (sourceFile.exists() && sourceFile.isAccessible()) {
+                sourceFile.setContents(is, true, false, null);
+            } else {
+                sourceFile.create(is, true, null);
+            }
+            project.refreshLocal(IResource.DEPTH_INFINITE, null);
+            
+            return sourceFile;
         }
-        is.close();
-        project.refreshLocal(IResource.DEPTH_INFINITE, null);
-
-        return sourceFile;
     }
 
     /**
@@ -192,7 +191,7 @@ public static boolean removePMDNature(final IProject project) throws CoreExcepti
             final String[] natureIds = description.getNatureIds();
             final String[] newNatureIds = new String[natureIds.length - 1];
             for (int i = 0, j = 0; i < natureIds.length; i++) {
-                if (!natureIds[i].equals(PMDNature.PMD_NATURE)) {
+                if (!PMDNature.PMD_NATURE.equals(natureIds[i])) {
                     newNatureIds[j++] = natureIds[i];
                 }
             }
@@ -265,7 +264,7 @@ private static boolean propertiesMatchFor(final Rule ruleA, final Rule ruleB) {
         // simple equals doesn't work for RegexProperties whose value type is java.util.regex.Pattern...
         //return ruleAProperties.equals(ruleBProperties);
 
-        if (ruleAProperties == ruleBProperties) {
+        if (ruleAProperties == ruleBProperties) { // NOPMD: CompareObjectsWithEquals is needed here
             return true;
         }
 

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/core/RuleSetManagerTest.java

@@ -74,8 +74,7 @@ public void testDuplicateUnregister() {
     }
 
     /**
-     * Unregistering twice the same Default rule set has no effect
-     * 
+     * Unregistering twice the same Default rule set has no effect.
      */
     @Test
     public void testDuplicateUnregisterDefault() {
@@ -88,8 +87,7 @@ public void testDuplicateUnregisterDefault() {
     }
 
     /**
-     * Test the register default ruleset
-     * 
+     * Test the register default ruleset.
      */
     @Test
     public void testRegisterDefaultRuleSet() {
@@ -99,36 +97,23 @@ public void testRegisterDefaultRuleSet() {
     }
 
     /**
-     * Test the registration of a null ruleset
-     * 
+     * Test the registration of a null ruleset.
      */
-    @Test
+    @Test(expected = IllegalArgumentException.class)
     public void testRegisterNullDefaultRuleSet() {
-        try {
-            this.ruleSetManager.registerDefaultRuleSet(null);
-            Assert.fail("Should return an IllegalArgumentException");
-        } catch (final IllegalArgumentException e) {
-            // cool
-        }
+        this.ruleSetManager.registerDefaultRuleSet(null);
     }
 
     /**
-     * Test the registration of a null ruleset
-     * 
+     * Test the registration of a null ruleset.
      */
-    @Test
+    @Test(expected = IllegalArgumentException.class)
     public void testRegisterNullRuleSet() {
-        try {
-            this.ruleSetManager.registerRuleSet(null);
-            Assert.fail("Should return an IllegalArgumentException");
-        } catch (final IllegalArgumentException e) {
-            // cool
-        }
+        this.ruleSetManager.registerRuleSet(null);
     }
 
     /**
-     * Test the register ruleset
-     * 
+     * Test the register ruleset.
      */
     @Test
     public void testRegisterRuleSet() {
@@ -138,8 +123,7 @@ public void testRegisterRuleSet() {
     }
 
     /**
-     * Test unregistration default
-     * 
+     * Test unregistration default.
      */
     @Test
     public void testUnregisterDefaultRuleSet() {
@@ -152,36 +136,23 @@ public void testUnregisterDefaultRuleSet() {
     }
 
     /**
-     * Unregistering a null default ruleset is illegal
-     * 
+     * Unregistering a null default ruleset is illegal.
      */
-    @Test
+    @Test(expected = RuntimeException.class)
     public void testUnregisterNullDefaultRuleSet() {
-        try {
-            this.ruleSetManager.unregisterDefaultRuleSet(null);
-            Assert.fail("An IllegalArgumentException should be returned");
-        } catch (final RuntimeException e) {
-            // cool
-        }
+        this.ruleSetManager.unregisterDefaultRuleSet(null);
     }
 
     /**
-     * Unregistering a null ruleset is illegal
-     * 
+     * Unregistering a null ruleset is illegal.
      */
-    @Test
+    @Test(expected = RuntimeException.class)
     public void testUnregisterNullRuleSet() {
-        try {
-            this.ruleSetManager.unregisterRuleSet(null);
-            Assert.fail("An IllegalArgumentException should be returned");
-        } catch (final RuntimeException e) {
-            // cool
-        }
+        this.ruleSetManager.unregisterRuleSet(null);
     }
 
     /**
-     * Test unregistration
-     * 
+     * Test unregistration.
      */
     @Test
     public void testUnregisterRuleSet() {

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/internal/ResourceUtil.java

@@ -5,11 +5,12 @@
 package net.sourceforge.pmd.eclipse.internal;
 
 import java.io.File;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
 
-public class ResourceUtil {
+public final class ResourceUtil {
     private ResourceUtil() {
         // utility
     }
@@ -19,7 +20,7 @@ public static void copyResource(Object context, String resource, File target) th
         if (parent != null && !parent.exists()) {
             parent.mkdirs();
         }
-        try (FileOutputStream out = new FileOutputStream(target);
+        try (OutputStream out = Files.newOutputStream(target.toPath());
              InputStream in = context.getClass().getResourceAsStream(resource)) {
             int count;
             byte[] buffer = new byte[8192];

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/DetectCutAndPasteCmdTest.java

@@ -29,9 +29,6 @@
 public class DetectCutAndPasteCmdTest {
     private IProject testProject;
 
-    /**
-     * @see junit.framework.TestCase#setUp()
-     */
     @Before
     public void setUp() throws Exception {
         // 1. Create a Java project
@@ -41,9 +38,9 @@ public void setUp() throws Exception {
 
         // 2. Create a test source file inside that project
         EclipseUtils.createTestSourceFile(this.testProject);
-        final InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java");
-        Assert.assertNotNull("Cannot find the test source file", is);
-        is.close();
+        try (InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java")) {
+            Assert.assertNotNull("Cannot find the test source file", is);
+        }
     }
 
     @After

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/RenderReportCmdTest.java

@@ -29,9 +29,6 @@
 public class RenderReportCmdTest {
     private IProject testProject;
 
-    /**
-     * @see junit.framework.TestCase#setUp()
-     */
     @Before
     public void setUp() throws Exception {
 
@@ -42,10 +39,9 @@ public void setUp() throws Exception {
 
         // 2. Create a test source file inside that project
         EclipseUtils.createTestSourceFile(this.testProject);
-        final InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java");
-        Assert.assertNotNull("Cannot find the test source file", is);
-        is.close();
-
+        try (InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java")) {
+            Assert.assertNotNull("Cannot find the test source file", is);
+        }
     }
 
     @After

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCmdTest.java

@@ -54,10 +54,10 @@ public void setUp() throws Exception {
                 this.testProject != null && this.testProject.exists() && this.testProject.isAccessible());
 
         // 2. Create a test source file inside that project
-        final IFile testFile = EclipseUtils.createTestSourceFile(this.testProject);
-        final InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java");
-        Assert.assertNotNull("Cannot find the test source file", is);
-        is.close();
+        EclipseUtils.createTestSourceFile(this.testProject);
+        try (InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java")) {
+            Assert.assertNotNull("Cannot find the test source file", is);
+        }
 
         // 3. Enable PMD for the test project
         IProjectProperties properties = PMDPlugin.getDefault().getPropertiesManager()
@@ -93,7 +93,7 @@ public void testReviewCmdBasic() throws CoreException {
 
         // We do not test PMD, only a non-empty report is enough
         Assert.assertNotNull(markers);
-        Assert.assertTrue("Report size = " + markers.size(), markers.size() > 0);
+        Assert.assertFalse("Report is empty", markers.isEmpty());
 
         // test the marker types - they should be problem markers...
         final IFile sourceFile = this.testProject.getFile("/src/Test.java");

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/ProjectPropertiesModelTest.java

@@ -19,6 +19,7 @@
 import java.util.Iterator;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Objects;
 import java.util.Set;
 
 import org.apache.commons.io.IOUtils;
@@ -125,7 +126,7 @@ public static void compareTwoRuleSets(RuleSet ruleSet1, RuleSet ruleSet2) {
                 Rule pluginRule = it1.next();
                 Rule projectRule = it2.next();
 
-                if (pluginRule != projectRule) {
+                if (!Objects.equals(pluginRule, projectRule)) {
                     System.out.println("i=" + i + ": pluginRule=" + pluginRule + " projectRule=" + projectRule);
                     System.out.println("plugin: " + pluginRule.getName() + " (" + pluginRule.getLanguage() + ")");
                     System.out.println("project: " + projectRule.getName() + " (" + projectRule.getLanguage() + ")");
@@ -172,7 +173,7 @@ public void testBug() throws PropertiesException, RuleSetNotFoundException, Core
         RuleSet rereadProjectRuleSet = model.getProjectRuleSet();
         Assert.assertEquals("The rule count should 1 less", ruleCountBefore - 1, rereadProjectRuleSet.getRules().size());
         for (Rule r : rereadProjectRuleSet.getRules()) {
-            if (r.getName().equals(removedRule.getName()) && r.getLanguage() == removedRule.getLanguage()) {
+            if (r.getName().equals(removedRule.getName()) && Objects.equals(r.getLanguage(), removedRule.getLanguage())) {
                 Assert.fail("The rule has not been removed!");
             }
         }
@@ -327,18 +328,12 @@ public String getName() {
      * It should not be possible to set to null a project ruleset
      * 
      */
-    @Test
+    @Test(expected = PropertiesException.class)
     public void testProjectRuleSetNull() throws PropertiesException {
         final IProjectPropertiesManager mgr = PMDPlugin.getDefault().getPropertiesManager();
         final IProjectProperties model = mgr.loadProjectProperties(this.testProject);
 
-        try {
-            model.setProjectRuleSetList(null);
-            Assert.fail("A ModelException must be raised when setting a project ruleset to null");
-        } catch (final PropertiesException e) {
-            // OK that's correct
-        }
-
+        model.setProjectRuleSetList(null);
     }
 
     /**
@@ -503,7 +498,8 @@ public void testNoRulesInProperties() throws PropertiesException, RuleSetNotFoun
     @Test(expected = PropertiesException.class)
     public void testInvalidProperties() throws PropertiesException, RuleSetNotFoundException, CoreException {
         final IProjectPropertiesManager mgr = PMDPlugin.getDefault().getPropertiesManager();
-        IProjectProperties model = mgr.loadProjectProperties(this.testProject);
+        // load the project properties to fill the cache
+        mgr.loadProjectProperties(this.testProject);
         // remove PMD's cached project properties, so that we reload it from disk again
         mgr.removeProjectProperties(this.testProject);
 
@@ -517,7 +513,7 @@ public void testInvalidProperties() throws PropertiesException, RuleSetNotFoundE
         file.setContents(propertiesStream, 0, null);
 
         // reload the project properties
-        model = mgr.loadProjectProperties(this.testProject);
+        mgr.loadProjectProperties(this.testProject);
     }
 
     private void dumpRuleSet(final RuleSet ruleSet) {
@@ -591,7 +587,7 @@ public void testProjectClasspath() throws Exception {
         file.setContents(IOUtils.toInputStream(newClasspathContent, "UTF-8"), 0, null);
         final IProjectPropertiesManager mgr = PMDPlugin.getDefault().getPropertiesManager();
         IProjectProperties model = mgr.loadProjectProperties(this.testProject);
-        URLClassLoader auxClasspath = (URLClassLoader) model.getAuxClasspath();
+        URLClassLoader auxClasspath = (URLClassLoader) model.getAuxClasspath(); // NOPMD: don't close auxclasspath in test, this should be done by the plugin
         Set<URI> urls = new HashSet<>();
         for (URL url : auxClasspath.getURLs()) {
             urls.add(url.toURI());

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/PMDCheckActionTest.java

@@ -36,9 +36,9 @@ public void setUp() throws Exception {
 
         // 2. Create a test source file inside that project
         EclipseUtils.createTestSourceFile(this.testProject);
-        final InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java");
-        Assert.assertNotNull("Cannot find the test source file", is);
-        is.close();
+        try (InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java")) {
+            Assert.assertNotNull("Cannot find the test source file", is);
+        }
 
         // 3. Enable PMD for the test project
         IProjectProperties properties = PMDPlugin.getDefault().getPropertiesManager()