Use Jspecify annotations

Author: jjohannes

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesExtension.java

@@ -41,11 +41,11 @@
 import org.gradle.api.provider.Provider;
 import org.gradle.api.provider.ProviderFactory;
 import org.gradle.api.tasks.SourceSet;
-import org.gradle.api.tasks.SourceSetContainer;
 import org.gradle.api.tasks.TaskProvider;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfoCache;
 import org.gradlex.javamodule.dependencies.tasks.SyntheticModuleInfoFoldersGenerate;
+import org.jspecify.annotations.Nullable;
 
 import javax.inject.Inject;
 import java.io.CharArrayReader;
@@ -73,9 +73,8 @@
  */
 public abstract class JavaModuleDependenciesExtension {
     static final String JAVA_MODULE_DEPENDENCIES = "javaModuleDependencies";
-    private static final String INTERNAL = "internal";
 
-    private final VersionCatalogsExtension versionCatalogs;
+    private final @Nullable VersionCatalogsExtension versionCatalogs;
 
     public abstract Property<ModuleInfoCache> getModuleInfoCache();
 
@@ -132,7 +131,7 @@ public abstract class JavaModuleDependenciesExtension {
      */
     public abstract Property<Boolean> getAnalyseOnly();
 
-    public JavaModuleDependenciesExtension(VersionCatalogsExtension versionCatalogs, File rootDir) {
+    public JavaModuleDependenciesExtension(@Nullable VersionCatalogsExtension versionCatalogs, File rootDir) {
         this.versionCatalogs = versionCatalogs;
         getModuleInfoCache().convention(getProviders().provider(() -> getObjects().newInstance(ModuleInfoCache.class, false)));
         getModulesProperties().set(new File(rootDir, "gradle/modules.properties"));
@@ -198,7 +197,7 @@ private String toProjectName(String moduleNameSuffix) {
         List<String> allProjectNames = getProject().getRootProject().getSubprojects().stream().map(Project::getName).collect(Collectors.toList());
 
         Optional<String> perfectMatch = allProjectNames.stream().filter(p -> p.replace("-", ".").equals(moduleNameSuffix)).findFirst();
-        Optional<String> existingProjectName = allProjectNames.stream().filter(p -> moduleNameSuffix != null && moduleNameSuffix.startsWith(p.replace("-", ".") + "."))
+        Optional<String> existingProjectName = allProjectNames.stream().filter(p -> moduleNameSuffix.startsWith(p.replace("-", ".") + "."))
                 .max(Comparator.comparingInt(String::length));
 
         if (perfectMatch.isPresent()) {
@@ -278,7 +277,7 @@ private Provider<Dependency> createWithGuessing(String moduleName, SourceSet sou
         });
     }
 
-    private ModuleDependency createExternalDependency(String moduleName) {
+    private @Nullable ModuleDependency createExternalDependency(String moduleName) {
         Provider<String> coordinates = getModuleNameToGA().getting(moduleName).orElse(mapByPrefix(getProviders().provider(() -> moduleName)));
         if (coordinates.isPresent()) {
             Map<String, Object> component;
@@ -572,7 +571,4 @@ private <T> Provider<T> errorIfNotFound(Provider<String> moduleName) {
 
     @Inject
     protected abstract ConfigurationContainer getConfigurations();
-
-    @Inject
-    protected abstract SourceSetContainer getSourceSets();
 }

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesPlugin.java

@@ -17,7 +17,6 @@
 package org.gradlex.javamodule.dependencies;
 
 import org.gradle.api.GradleException;
-import org.gradle.api.NonNullApi;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.Task;
@@ -64,7 +63,6 @@
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleNamingUtil.sourceSetToModuleName;
 
 @SuppressWarnings("unused")
-@NonNullApi
 public abstract class JavaModuleDependenciesPlugin implements Plugin<ExtensionAware> {
 
     private static final String EXTRA_JAVA_MODULE_INFO_PLUGIN_ID = "org.gradlex.extra-java-module-info";
@@ -84,6 +82,7 @@ public void apply(ExtensionAware projectOrSettings) {
 
     private void applyProject(Project project) {
         VersionCatalogsExtension versionCatalogs = project.getExtensions().findByType(VersionCatalogsExtension.class);
+        @SuppressWarnings("DataFlowIssue")
         JavaModuleDependenciesExtension javaModuleDependencies = project.getExtensions().create(
                 JAVA_MODULE_DEPENDENCIES, JavaModuleDependenciesExtension.class, versionCatalogs, project.getRootDir());
 
@@ -151,6 +150,7 @@ private void setupModuleDependenciesTask(Project project) {
         TaskProvider<ModuleDependencyReport> moduleDependencies = project.getTasks().register("moduleDependencies", ModuleDependencyReport.class, t -> t.setGroup(HELP_GROUP));
         sourceSets.all(sourceSet -> moduleDependencies.configure(t -> {
             HashSet<Configuration> joined = new HashSet<>();
+            //noinspection ConstantValue
             if (t.getConfigurations() != null) {
                 joined.addAll(t.getConfigurations());
             }

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleVersionsPlugin.java

@@ -16,7 +16,6 @@
 
 package org.gradlex.javamodule.dependencies;
 
-import org.gradle.api.NonNullApi;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.Configuration;
@@ -30,8 +29,8 @@
 import org.gradlex.javamodule.dependencies.dsl.ModuleVersions;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo;
 import org.gradlex.javamodule.dependencies.tasks.CatalogGenerate;
+import org.jspecify.annotations.Nullable;
 
-import javax.annotation.Nullable;
 import java.io.File;
 import java.util.Arrays;
 import java.util.List;
@@ -47,7 +46,6 @@
 import static org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo.Directive.REQUIRES_TRANSITIVE;
 
 @SuppressWarnings("unused")
-@NonNullApi
 public abstract class JavaModuleVersionsPlugin implements Plugin<Project> {
 
     @Override

src/main/java/org/gradlex/javamodule/dependencies/SharedMappings.java

@@ -16,6 +16,8 @@
 
 package org.gradlex.javamodule.dependencies;
 
+import org.jspecify.annotations.Nullable;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Map;
@@ -27,7 +29,7 @@ final public class SharedMappings {
     static Map<String, String> loadModuleNameToGAProperties() {
         Properties properties = new Properties() {
             @Override
-            public synchronized Object put(Object key, Object value) {
+            public synchronized @Nullable Object put(Object key, Object value) {
                 if (get(key) != null) {
                     throw new IllegalArgumentException(key + " already present.");
                 }

src/main/java/org/gradlex/javamodule/dependencies/dsl/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright the GradleX team.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+@NullMarked
+package org.gradlex.javamodule.dependencies.dsl;
+
+import org.jspecify.annotations.NullMarked;

src/main/java/org/gradlex/javamodule/dependencies/initialization/JavaModuleDependenciesSettingsPlugin.java

@@ -17,12 +17,10 @@
 package org.gradlex.javamodule.dependencies.initialization;
 
 import org.gradle.api.GradleException;
-import org.gradle.api.NonNullApi;
 import org.gradle.api.Plugin;
 import org.gradle.api.initialization.Settings;
 import org.gradle.util.GradleVersion;
 
-@NonNullApi
 public abstract class JavaModuleDependenciesSettingsPlugin implements Plugin<Settings> {
 
     @Override

src/main/java/org/gradlex/javamodule/dependencies/initialization/JavaModulesExtension.java

@@ -18,7 +18,6 @@
 
 import org.gradle.api.Action;
 import org.gradle.api.IsolatedAction;
-import org.gradle.api.NonNullApi;
 import org.gradle.api.Project;
 import org.gradle.api.initialization.ProjectDescriptor;
 import org.gradle.api.initialization.Settings;
@@ -35,6 +34,7 @@
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfoCache;
 import org.gradlex.javamodule.dependencies.internal.utils.ValueModuleDirectoryListing;
+import org.jspecify.annotations.Nullable;
 
 import javax.inject.Inject;
 import java.io.File;
@@ -165,19 +165,18 @@ private void configureModule(Module module, ProjectDescriptor project) {
 
     private static class ModuleProject {
         private final String path;
-        private final String group;
+        private final @Nullable String group;
         private final List<String> plugins;
-        private final String mainModuleName;
+        private final @Nullable String mainModuleName;
 
-        public ModuleProject(String path, String group, List<String> plugins, String mainModuleName) {
+        public ModuleProject(String path, @Nullable String group, List<String> plugins, @Nullable String mainModuleName) {
             this.path = path;
             this.group = group;
             this.plugins = plugins;
             this.mainModuleName = mainModuleName;
         }
     }
 
-    @NonNullApi
     private static class ApplyPluginsAction implements IsolatedAction<Project> {
 
         private final List<ModuleProject> moduleProjects;
@@ -205,7 +204,6 @@ public void execute(Project project) {
         }
     }
 
-    @NonNullApi
     private static class ApplyJavaModuleVersionsPluginAction implements IsolatedAction<Project> {
 
         private final String projectPath;

src/main/java/org/gradlex/javamodule/dependencies/initialization/RootPluginsExtension.java

@@ -17,7 +17,6 @@
 package org.gradlex.javamodule.dependencies.initialization;
 
 import org.gradle.api.IsolatedAction;
-import org.gradle.api.NonNullApi;
 import org.gradle.api.Project;
 import org.gradle.api.initialization.Settings;
 
@@ -38,7 +37,6 @@ public void id(String id) {
         ids.add(id);
     }
 
-    @NonNullApi
     private static class ApplyPluginAction implements IsolatedAction<Project> {
 
         private final List<String> ids;

src/main/java/org/gradlex/javamodule/dependencies/initialization/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright the GradleX team.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+@NullMarked
+package org.gradlex.javamodule.dependencies.initialization;
+
+import org.jspecify.annotations.NullMarked;

src/main/java/org/gradlex/javamodule/dependencies/internal/bridges/DependencyAnalysisBridge.java

@@ -25,8 +25,8 @@
 import org.gradle.api.tasks.TaskProvider;
 import org.gradlex.javamodule.dependencies.tasks.ModuleDirectivesOrderingCheck;
 import org.gradlex.javamodule.dependencies.tasks.ModuleDirectivesScopeCheck;
+import org.jspecify.annotations.Nullable;
 
-import javax.annotation.Nullable;
 import java.io.File;
 
 public class DependencyAnalysisBridge {