Merge branch 'master' into feature/VNA04-J-thread-atomicity

Author: gtoison

CHANGELOG.md

@@ -27,7 +27,7 @@ Currently the versioning policy of this project follows [Semantic Versioning v2.
 - Recognize some classes as immutable, fixing EI_EXPOSE and MS_EXPOSE FPs ([#3137](https://github.com/spotbugs/spotbugs/pull/3137))
 
 ### Cleanup
-- Cleaup thread issue and regex issue in test-harness ([#3130](https://github.com/spotbugs/spotbugs/issues/3130))
+- Cleanup thread issue and regex issue in test-harness ([#3130](https://github.com/spotbugs/spotbugs/issues/3130))
 - Remove extra blank lines and remove public from interface objects as inherently already public ([#3131](https://github.com/spotbugs/spotbugs/issues/3131))
 - Fix order of modifiers on properties/methods and ensure correct location in file ([#3132](https://github.com/spotbugs/spotbugs/issues/3132))
 - Return objects directly instead of creating more garbage collection by defining them ([#3133](https://github.com/spotbugs/spotbugs/issues/3133))
@@ -37,6 +37,9 @@ Currently the versioning policy of this project follows [Semantic Versioning v2.
 - New detector `ResourceInMultipleThreadsDetector` and introduced new bug type:
   - `AT_UNSAFE_RESOURCE_ACCESS_IN_THREAD` is reported in case of unsafe resource access in multiple threads.
 
+### Changed
+- Bump up Java version to 11
+
 ## 4.8.6 - 2024-06-17
 ### Fixed
 - Do not report BC_UNCONFIRMED_CAST for Java 21's type switches when the switch instruction is TABLESWITCH ([#2782](https://github.com/spotbugs/spotbugs/issues/2782))
@@ -600,7 +603,7 @@ This version contains no change, except for the solution for [a deployment probl
 * Replace to try-with-resources
 * Reset DataAnalysis.DEBUG back when analysis reaches MAX_ITER
 * Remove unused methods in `BCELUtil`
-* Remove unused methods and deperecated methods in `edu.umd.cs.findbugs.util.Util`
+* Remove unused methods and deprecated methods in `edu.umd.cs.findbugs.util.Util`
 * Change to removeIf from Iterator and Iterator.remove
 * Use Map.computeIfAbsent instead of Map.get and Map.put
 * Use for-each instead of for-loop and while-loop
@@ -665,7 +668,7 @@ This version contains no change, except for the solution for [a deployment probl
 * edu.umd.cs.findbugs.util.ClassName#assertIsSlashed return type is changed to void
 
 ### Deprecated
-* edu.umd.cs.findbugs.classfile.ClassDescriptor#toDottedClassName() is depricated and getDottedClassName() can be used instead.
+* edu.umd.cs.findbugs.classfile.ClassDescriptor#toDottedClassName() is deprecated and getDottedClassName() can be used instead.
 
 ## 3.1.9 - 2018-11-20
 

README.md

@@ -17,7 +17,7 @@ More information at the [official website](https://spotbugs.github.io/). A lot o
 
 SpotBugs is built using [Gradle](https://gradle.org). The recommended way to obtain it is to simply run the `gradlew` (or `gradlew.bat`) wrapper, which will automatically download and run the correct version as needed (using the settings in `gradle/wrapper/gradle-wrapper.properties`).
 
-Building SpotBugs requires JDK 21 to run all the tests (using SpotBugs requires JDK 8 or above).
+Building SpotBugs requires JDK 21 to run all the tests (using SpotBugs requires JDK 11 or above, but it can analyze code compiled with older versions).
 
 To see a list of build options, run `gradle tasks` (or `gradlew tasks`). The `build` task will perform a full build and test.
 

build.gradle

@@ -30,7 +30,7 @@ allprojects {
     mavenCentral()
   }
   dependencies {
-    def junitVersion = '5.11.1'
+    def junitVersion = '5.11.2'
     compileOnly platform("org.junit:junit-bom:$junitVersion")
     testImplementation platform("org.junit:junit-bom:$junitVersion")
   }

docs/annotations.rst

@@ -4,6 +4,12 @@ Annotations
 SpotBugs supports several annotations to express the developer's intent so that SpotBugs can issue warnings more appropriately.
 Annotations for SpotBugs.
 
+.. literalinclude:: generated/migration-findbugs-annotations-maven.template.inc
+    :language: xml
+
+.. literalinclude:: generated/migration-findbugs-annotations-gradle.template.inc
+    :language: groovy
+
 edu.umd.cs.findbugs.annotations.CheckForNull
 --------------------------------------------
 The annotated element might be null, and uses of the element should check for null.

docs/locale/ja/LC_MESSAGES/bugDescriptions.po

@@ -3978,7 +3978,7 @@ msgstr ""
 #: ../../generated/bugDescriptionList.inc:3908
 msgid ""
 "    <p>\n"
-"This partical method invocation doesn't make sense, for reasons that "
+"This partial method invocation doesn't make sense, for reasons that "
 "should be apparent from inspection.\n"
 "</p>"
 msgstr ""

eclipsePlugin-junit/build.gradle

@@ -11,7 +11,7 @@ tasks.named('compileJava', JavaCompile).configure {
 
 dependencies {
   implementation project(':eclipsePlugin')
-  testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.11.1'
+  testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.11.2'
   testImplementation 'org.mockito:mockito-core:5.14.1'
 }
 

eclipsePlugin-test/build.gradle

@@ -26,7 +26,7 @@ dependencies {
   }
 
   implementation project(':test-harness')
-  implementation 'org.junit.jupiter:junit-jupiter-engine:5.11.1'
+  implementation 'org.junit.jupiter:junit-jupiter-engine:5.11.2'
   implementation 'org.apache.ant:ant:1.10.15'
 }
 

eclipsePlugin/RELEASENOTES

@@ -40,7 +40,7 @@ Release 1.3.8 - Andrey Loskutov
 - feature: added FindBugs perspective link to all Java perspectives
 - feature 2022229: have workspace level preferences for FindBugs
     per default, workspace settings are used for new plugins
-    plugins with existing .fbprefs files are assumed to have custom preferences until they explicitely disable project prefs
+    plugins with existing .fbprefs files are assumed to have custom preferences until they explicitly disable project prefs
     per default, Eclipse will not enable categories EXPERIMENTAL,I18N,MALICIOUS_CODE,SECURITY for new projects
     FilterFiles tab: now dialog will disallow invalid selection of filter files
 - internal rework of job scheduling: use same rule for all FB jobs.
@@ -50,7 +50,7 @@ Release 1.3.8 - Andrey Loskutov
 - feature: property view shows bug counts info for elements selected in bug explorer
 - feature: added "navigate - Show In - Bug Explorer" menu entry in all Java perspectives
 - feature: added "Show Bug Details" action to Java editor ruler
-- feature: replaced bug details view with standart properties view, supporting Java editor
+- feature: replaced bug details view with standard properties view, supporting Java editor
     bug details view exists no more, perspective definition changed
 - bugfix: fixed bug explorer (common navigator) errors with Eclipse 3.5
 - feature: filtering by specific pattern from bug explorer
@@ -142,14 +142,14 @@ Release 1.3.0 - FindBugs team
 - Include/Exclude filter-file selector now sanity-checks selection
 
 Release 1.2.2 - major code cleanup and refactoring by Andrey Loskutov
-- fixed non-Eclipse-like behavoir of view selection/activation/opening (work in progress)
+- fixed non-Eclipse-like behavior of view selection/activation/opening (work in progress)
 - bud tree view monitors resource changes now
 - refactoring of all FindBugs views
 - created new icons for findbugs action and views
 - created new FindBugs perspective
 - fixed popup contribution for the problems view (was never functional)
-- no system.out.println callls without if(DEBUG) flag
-- no printStackTrace() callls without if(DEBUG) flag
+- no system.out.println calls without if(DEBUG) flag
+- no printStackTrace() calls without if(DEBUG) flag
 - other code cleanup
 
 Release 0.1.0 - some enhancements by Peter Friese

eclipsePlugin/build.gradle

@@ -3,7 +3,7 @@ import static groovy.io.FileType.FILES
 // TODO: deploy not only jar but also sources and javadoc, to pass validation by Sonatype nexus
 // apply from: "$rootDir/gradle/maven.gradle"
 plugins {
-  id 'org.ajoberstar.grgit' version '5.2.2'
+  id 'org.ajoberstar.grgit' version '5.3.0'
   id "eclipse-convention"
 }
 

eclipsePlugin/doc/installing_findbugsplugin.txt

@@ -65,7 +65,7 @@ Manual mode
 ------------
 Since running the FindBugs plug-in in automatic mode can be vey time-consuming,
 you may choose to run the plug-in in manual mode. As the name implies, you
-have to start the bug pattern detecion manually when the plug-in is in manual mode.
+have to start the bug pattern detection manually when the plug-in is in manual mode.
 
 To enable manual mode:
 1) Make sure that the [Run FindBugs automatically] checkbox on the Java project properties

eclipsePlugin/src/de/tobject/findbugs/FindbugsSaveParticipant.java

@@ -26,7 +26,7 @@
 import de.tobject.findbugs.util.ProjectUtilities;
 
 /**
- * Callback object responsible for saving the uncomitted state of any
+ * Callback object responsible for saving the uncommitted state of any
  * FindBugs-enabled projects.
  *
  * @author David Hovemeyer

eclipsePlugin/src/de/tobject/findbugs/actions/MarkerRulerAction.java

@@ -84,7 +84,7 @@ public MarkerRulerAction() {
     @Override
     public void setActiveEditor(IAction callerAction, IEditorPart targetEditor) {
         Control control;
-        // See if we're already listenting to an editor; if so, stop listening
+        // See if we're already listening to an editor; if so, stop listening
         if (editor != null) {
             if (ruler != null) {
                 control = ruler.getControl();

eclipsePlugin/src/de/tobject/findbugs/builder/FindBugsBuilder.java

@@ -94,7 +94,7 @@ protected IProject[] build(int kind, Map args, IProgressMonitor monitor) throws
         default: {
 
             FindbugsPlugin.getDefault()
-                    .logWarning("UKNOWN BUILD kind" + kind);
+                    .logWarning("UNKNOWN BUILD kind" + kind);
             doBuild(args, monitor, kind);
             break;
         }

eclipsePlugin/src/de/tobject/findbugs/reporter/JdtUtils.java

@@ -2,7 +2,7 @@
  * Contributions to FindBugs
  * Copyright (C) 2009, Andrei Loskutov
  *
- * The original code was developed by Andrei Loskutov under the BSD lizense for the
+ * The original code was developed by Andrei Loskutov under the BSD license for the
  * Bytecode Outline plugin at http://andrei.gmxhome.de/bytecode/index.html
  *
  * This library is free software; you can redistribute it and/or
@@ -419,7 +419,7 @@ private static int getAnonCompilePriority(IJavaElement elt, IJavaElement firstAn
      * opposite to rule 2)
      *
      * @param javaElement
-     * @return priority - lesser mean wil be compiled later, a value > 0
+     * @return priority - lesser mean will be compiled later, a value > 0
      */
     private static int getAnonCompilePriority50(IJavaElement javaElement, IJavaElement firstAncestor, IJavaElement topAncestor) {
 

eclipsePlugin/src/de/tobject/findbugs/reporter/MarkerReporter.java

@@ -125,7 +125,7 @@ private void addMarker(MarkerParameter mp) throws CoreException {
                 oldMarker.delete();
             }
         }
-        // XXX With Eclipse 4.19, we could use *single* method to create marker with attribures
+        // XXX With Eclipse 4.19, we could use *single* method to create marker with attributes
         // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=570914
         // We can use that once we have 4.19 as minimum platform
         IMarker newMarker = markerTarget.createMarker(mp.markerType);

eclipsePlugin/src/de/tobject/findbugs/util/EditorUtil.java

@@ -54,7 +54,7 @@ public static void goToLine(IEditorPart editorPart, int lineNumber) {
         if (document != null) {
             IRegion lineInfo = null;
             try {
-                // line count internaly starts with 0, and not with 1 like in
+                // line count internally starts with 0, and not with 1 like in
                 // GUI
                 lineInfo = document.getLineInformation(lineNumber - 1);
             } catch (BadLocationException e) {

eclipsePlugin/src/de/tobject/findbugs/view/explorer/BugContentProvider.java

@@ -508,7 +508,7 @@ public synchronized Set<BugGroup> updateContent(List<DeltaInfo> deltas) {
                 break;
             default:
                 FindbugsPlugin.getDefault()
-                        .logWarning("UKNOWN delta change kind" + delta.changeKind);
+                        .logWarning("UNKNOWN delta change kind" + delta.changeKind);
 
             }
         }

eclipsePlugin/src/de/tobject/findbugs/view/explorer/FilterBugsDialog.java

@@ -340,7 +340,7 @@ public boolean close() {
             // allow to specify filters using text area (no validation checks
             // yet)
             // TODO validate text entered by user and throw away
-            // invalide/duplicated entries
+            // invalid/duplicated entries
             selectedAsText = text;
         } else {
             selectedAsText = computed;
@@ -492,7 +492,7 @@ private ContainerCheckedTreeViewer createTree(Composite parent, int style) {
         final ContainerCheckedTreeViewer viewer = new ContainerCheckedTreeViewer(parent, style | SWT.SINGLE | SWT.BORDER
                 | SWT.V_SCROLL | SWT.H_SCROLL | SWT.RESIZE) {
             /**
-             * Overriden to re-set checked state of elements after filter change
+             * Overridden to re-set checked state of elements after filter change
              */
             @Override
             public void refresh(boolean updateLabels) {

eclipsePlugin/src/edu/umd/cs/findbugs/plugin/eclipse/quickfix/BugResolutionAssociations.java

@@ -38,7 +38,7 @@
 
 /**
  * The <CODE>BugResolutionAssociations</CODE> is the container for the loaded
- * bug-resolutions. For each registred bug pattern, at least one resolution-class
+ * bug-resolutions. For each registered bug pattern, at least one resolution-class
  * has to be specified. Also an instance of a bug resolution can be associated
  * with a bug pattern.
  *

eclipsePlugin/src/edu/umd/cs/findbugs/plugin/eclipse/quickfix/BugResolutionGenerator.java

@@ -32,7 +32,7 @@
 import de.tobject.findbugs.reporter.MarkerUtil;
 
 /**
- * The <CODE>BugResolutionGenerator</CODE> searchs for bug-resolutions, that can
+ * The <CODE>BugResolutionGenerator</CODE> searches for bug-resolutions, that can
  * be used to fix the specific bug-type.
  *
  * @author <a href="mailto:[email protected]">Thierry Wyss</a>

eclipsePlugin/src/edu/umd/cs/findbugs/plugin/eclipse/quickfix/util/ASTUtil.java

@@ -183,7 +183,7 @@ public static ASTNode getASTNode(CompilationUnit compilationUnit, SourceLineAnno
     }
 
     /**
-     * Searchs the first <CODE>ASTNode</CODE> between the specified
+     * Searches the first <CODE>ASTNode</CODE> between the specified
      * <CODE>startLine</CODE> and <CODE>endLine</CODE>. If the source line
      * doesn't contain an <CODE>ASTNode</CODE>, a
      * <CODE>ASTNodeNotFoundException</CODE> is thrown.
@@ -196,7 +196,7 @@ public static ASTNode getASTNode(CompilationUnit compilationUnit, SourceLineAnno
      * @param endLine
      *            the ending source line number.
      * @throws ASTNodeNotFoundException
-     *             if no <CODE>ASTNode</CODE> found between the specifed start
+     *             if no <CODE>ASTNode</CODE> found between the specified start
      *             and end line.
      */
     public static ASTNode getASTNode(CompilationUnit compilationUnit, int startLine, int endLine) throws ASTNodeNotFoundException {

gradle/java.gradle

@@ -8,7 +8,7 @@ tasks.withType(Javadoc).configureEach {
     options.encoding = 'UTF-8'
 }
 tasks.named('compileJava', JavaCompile).configure {
-    options.release = 8
+    options.release = 11
 }
 
 // make the build reproducible https://reproducible-builds.org/

gradle/libs.versions.toml

@@ -1,5 +1,5 @@
 [versions]
-asm = "9.7"
+asm = "9.7.1"
 guice = "5.1.0"
 log4j = "2.24.1"
 

spotbugs-ant/build.gradle

@@ -8,7 +8,7 @@ dependencies {
   compileOnly 'org.apache.ant:ant:1.10.15'
 
   testImplementation 'org.apache.ant:ant:1.10.15'
-  testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.11.1'
+  testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.11.2'
   testImplementation 'org.hamcrest:hamcrest:3.0'
 }
 

spotbugs-tests/build.gradle

@@ -12,8 +12,8 @@ dependencies {
   implementation project(':test-harness')
   implementation project(':test-harness-jupiter')
 
-  implementation 'org.junit.jupiter:junit-jupiter-engine:5.11.1'
-  implementation 'org.junit.jupiter:junit-jupiter-params:5.11.1'
+  implementation 'org.junit.jupiter:junit-jupiter-engine:5.11.2'
+  implementation 'org.junit.jupiter:junit-jupiter-params:5.11.2'
   implementation 'org.hamcrest:hamcrest:3.0'
   implementation 'org.apache.ant:ant:1.10.15'
   implementation libs.log4j.core

spotbugs-tests/src/test/java/edu/umd/cs/findbugs/detect/DontReusePublicIdentifiersTest.java

@@ -46,7 +46,6 @@ void testGoodPublicIdentifiersClassNames() {
 
         // check good public identifiers as inner classes
         performAnalysis("publicIdentifiers/inner/GoodPublicIdentifiersInnerClassNames.class",
-                "publicIdentifiers/inner/GoodPublicIdentifiersInnerClassNames$1.class",
                 "publicIdentifiers/inner/GoodPublicIdentifiersInnerClassNames$MyBuffer.class",
                 "publicIdentifiers/inner/GoodPublicIdentifiersInnerClassNames$MyFile.class",
                 "publicIdentifiers/inner/GoodPublicIdentifiersInnerClassNames$MyBigInteger.class");

spotbugs-tests/src/test/java/edu/umd/cs/findbugs/detect/FindArgumentAssertionsTest.java

@@ -46,7 +46,7 @@ void testArgumentAssertions() {
         assertNoBugInMethod(BUG_TYPE, "ArgumentAssertions", "privateFinalMethod");
         assertNoBugInMethod(BUG_TYPE, "ArgumentAssertions", "privateStaticMethod");
         assertDABug("assertingArgInFor", 198);
-        // assertDABug("lambda$assertingArgInStream$0", 206); // assertations inside streams are not supported yet
+        // assertDABug("lambda$assertingArgInStream$0", 206); // assertions inside streams are not supported yet
     }
 
     private void assertDABug(String method, int line) {

spotbugs-tests/src/test/java/edu/umd/cs/findbugs/detect/Issue2465Test.java

@@ -9,7 +9,7 @@ class Issue2465Test extends AbstractIntegrationTest {
 
     @Test
     void testIssue() {
-        Assertions.assertDoesNotThrow(() -> performAnalysis("ghIssues/Issue2465.class", "ghIssues/Issue2465$1.class",
+        Assertions.assertDoesNotThrow(() -> performAnalysis("ghIssues/Issue2465.class",
                 "ghIssues/Issue2465$Role.class"));
     }
 }

spotbugs-tests/src/test/java/edu/umd/cs/findbugs/detect/Issue2968Test.java

@@ -9,7 +9,6 @@ class Issue2968Test extends AbstractIntegrationTest {
     void testIssue() {
         performAnalysis(
                 "ghIssues/Issue2968.class",
-                "ghIssues/Issue2968$1.class",
                 "ghIssues/Issue2968$TestIf.class",
                 "ghIssues/Issue2968$CommonException.class",
                 "ghIssues/Issue2968$ActualException.class",

spotbugs-tests/src/test/java/edu/umd/cs/findbugs/detect/MultipleInstantiationsOfSingletonsTest.java

@@ -16,15 +16,13 @@ void abstractClassTest() {
     @Test
     void innerChildInstanceTest() {
         performAnalysis("singletons/InnerChildInstance.class",
-                "singletons/InnerChildInstance$Unknown.class",
-                "singletons/InnerChildInstance$1.class");
+                "singletons/InnerChildInstance$Unknown.class");
         assertNoBugs();
     }
 
     @Test
     void innerChildAndMoreInstanceTest() {
         performAnalysis("singletons/InnerChildAndMoreInstance.class",
-                "singletons/InnerChildAndMoreInstance$1.class",
                 "singletons/InnerChildAndMoreInstance$Unknown.class");
         assertBugTypeCount("SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR", 1);
         assertBugInClass("SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR", "InnerChildAndMoreInstance");
@@ -39,7 +37,6 @@ void innerChildAndMoreInstanceTest() {
     @Test
     void InnerChildAndMoreInstanceReorderedTest() {
         performAnalysis("singletons/InnerChildAndMoreInstanceReordered.class",
-                "singletons/InnerChildAndMoreInstanceReordered$1.class",
                 "singletons/InnerChildAndMoreInstanceReordered$Unknown.class");
         assertBugTypeCount("SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR", 1);
         assertBugInClass("SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR", "InnerChildAndMoreInstanceReordered");
@@ -54,7 +51,6 @@ void InnerChildAndMoreInstanceReorderedTest() {
     @Test
     void InnerChildAndMoreInstanceNoGetterTest() {
         performAnalysis("singletons/InnerChildAndMoreInstanceNoGetter.class",
-                "singletons/InnerChildAndMoreInstanceNoGetter$1.class",
                 "singletons/InnerChildAndMoreInstanceNoGetter$Unknown.class");
         assertNoBugs();
     }

spotbugs/build.gradle

@@ -4,7 +4,7 @@ apply from: "$rootDir/gradle/checkstyle.gradle"
 apply from: "$rootDir/gradle/javadoc.gradle"
 
 tasks.named('compileJava', JavaCompile).configure {
-    options.release = 8
+    options.release = 11
 }
 
 // Force Eclipse use Java 1.8, otherwise it will get Java 17 (!) from gradle
@@ -103,7 +103,7 @@ clean {
 }
 
 tasks.named('compileGuiJava', JavaCompile).configure {
-  options.release = 8
+  options.release = 11
 }
 
 tasks.withType(Jar).configureEach {