Replace JetBrains annotations with JSpecify

Replaced all occurrences of JetBrains annotations with JSpecify annotations across various classes to ensure consistency and modernize the codebase. Updated the build.gradle.kts to include JSpecify as a dependency for both compile and test environments.

Author: david

version-checker/build.gradle.kts

@@ -23,12 +23,11 @@ repositories {
 
 dependencies {
     compileOnly("org.projectlombok:lombok:1.18.34")
-    compileOnly("org.jetbrains:annotations:24.1.0")
-    compileOnly(project(":annotations"))
 
     api("com.google.code.gson:gson:2.11.0")
+    compileOnly("org.jspecify:jspecify:1.0.0")
 
-    testCompileOnly(project(":annotations"))
+    testCompileOnly("org.jspecify:jspecify:1.0.0")
 
     testImplementation(platform("org.junit:junit-bom:5.10.0"))
     testImplementation("org.junit.jupiter:junit-jupiter")

version-checker/src/main/java/core/version/SemanticVersion.java

@@ -1,17 +1,15 @@
 package core.version;
 
-import core.annotation.MethodsReturnNotNullByDefault;
-import core.annotation.ParametersAreNotNullByDefault;
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.util.Objects;
 
 /**
  * The SemanticVersion class represents a <a href="https://semver.org/">semantic version number</a>.
  * It implements the Version interface and provides methods to access and compare version components.
  */
-@MethodsReturnNotNullByDefault
-@ParametersAreNotNullByDefault
+@NullMarked
 public record SemanticVersion(int major, int minor, int patch, @Nullable String preRelease) implements Version {
     /**
      * The PATTERN variable represents the regular expression pattern for a semantic version number.

version-checker/src/main/java/core/version/Version.java

@@ -1,6 +1,6 @@
 package core.version;
 
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * The {@code Version} interface represents a version number without format.

version-checker/src/main/java/core/version/VersionChecker.java

@@ -1,11 +1,12 @@
 package core.version;
 
-import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
+@NullMarked
 public interface VersionChecker<N, V extends Version> {
     /**
      * Retrieves the version of the currently running software.
@@ -50,7 +51,7 @@ public interface VersionChecker<N, V extends Version> {
      *
      * @return a CompletableFuture containing a Set of all versions
      */
-    CompletableFuture<@Unmodifiable Set<V>> retrieveVersions();
+    CompletableFuture<Set<V>> retrieveVersions();
 
     /**
      * Retrieves the latest supported version of the software asynchronously.
@@ -64,15 +65,13 @@ public interface VersionChecker<N, V extends Version> {
      *
      * @return an unmodifiable {@code Set} of supported versions
      */
-    @Unmodifiable
     Set<V> getSupportedVersions();
 
     /**
      * Retrieves all available versions that have been queried up to this point.
      *
      * @return an unmodifiable {@code Set} of all available versions
      */
-    @Unmodifiable
     Set<V> getVersions();
 
     /**

version-checker/src/main/java/core/version/github/GitHubVersionChecker.java

@@ -2,15 +2,11 @@
 
 import com.google.gson.Gson;
 import com.google.gson.reflect.TypeToken;
-import core.annotation.FieldsAreNotNullByDefault;
-import core.annotation.MethodsReturnNotNullByDefault;
-import core.annotation.ParametersAreNotNullByDefault;
-import core.annotation.TypesAreNotNullByDefault;
 import core.version.Version;
 import core.version.VersionChecker;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.NullMarked;
 
 import java.net.URI;
 import java.net.http.HttpClient;
@@ -23,11 +19,8 @@
 import java.util.stream.Collectors;
 
 @Getter
+@NullMarked
 @RequiredArgsConstructor
-@TypesAreNotNullByDefault
-@FieldsAreNotNullByDefault
-@MethodsReturnNotNullByDefault
-@ParametersAreNotNullByDefault
 public abstract class GitHubVersionChecker<V extends Version> implements VersionChecker<Release, V> {
     private static final String API_URL = "https://api.github.com/repos/%s/%s/";
     private static final HttpClient client = HttpClient.newBuilder()
@@ -56,7 +49,7 @@ public CompletableFuture<V> retrieveLatestVersion() {
     }
 
     @Override
-    public CompletableFuture<@Unmodifiable Set<V>> retrieveVersions() {
+    public CompletableFuture<Set<V>> retrieveVersions() {
         return retrieveGitHubReleases().thenApply(versions -> versions.stream()
                 .map(this::parseVersion)
                 .collect(Collectors.toUnmodifiableSet()));
@@ -72,14 +65,14 @@ public CompletableFuture<V> retrieveLatestSupportedVersion() {
     }
 
     @Override
-    public @Unmodifiable Set<V> getSupportedVersions() {
+    public Set<V> getSupportedVersions() {
         return releases.stream()
                 .filter(this::isSupported)
                 .map(this::parseVersion)
                 .collect(Collectors.toUnmodifiableSet());
     }
 
-    public @Unmodifiable Set<V> getVersions() {
+    public Set<V> getVersions() {
         return releases.stream()
                 .map(this::parseVersion)
                 .collect(Collectors.toUnmodifiableSet());

version-checker/src/main/java/core/version/github/Release.java

@@ -1,7 +1,9 @@
 package core.version.github;
 
 import com.google.gson.annotations.SerializedName;
+import org.jspecify.annotations.NullMarked;
 
+@NullMarked
 public record Release(
         @SerializedName("html_url") String url,
         @SerializedName("tag_name") String tag,

version-checker/src/main/java/core/version/hangar/HangarVersion.java

@@ -1,7 +1,10 @@
 package core.version.hangar;
 
+import org.jspecify.annotations.NullMarked;
+
 import java.util.List;
 import java.util.Map;
 
+@NullMarked
 public record HangarVersion(String name, String author, Map<Platform, List<String>> platformDependencies) {
 }

version-checker/src/main/java/core/version/hangar/HangarVersionChecker.java

@@ -1,15 +1,11 @@
 package core.version.hangar;
 
 import com.google.gson.Gson;
-import core.annotation.FieldsAreNotNullByDefault;
-import core.annotation.MethodsReturnNotNullByDefault;
-import core.annotation.ParametersAreNotNullByDefault;
-import core.annotation.TypesAreNotNullByDefault;
 import core.version.Version;
 import core.version.VersionChecker;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.NullMarked;
 
 import java.net.URI;
 import java.net.http.HttpClient;
@@ -28,11 +24,8 @@
  * @param <V> the type parameter for the version
  */
 @Getter
+@NullMarked
 @RequiredArgsConstructor
-@TypesAreNotNullByDefault
-@FieldsAreNotNullByDefault
-@MethodsReturnNotNullByDefault
-@ParametersAreNotNullByDefault
 public abstract class HangarVersionChecker<V extends Version> implements VersionChecker<HangarVersion, V> {
     private static final String API_URL = "https://hangar.papermc.io/api/v1/projects/%s/";
     private static final HttpClient client = HttpClient.newBuilder()
@@ -60,7 +53,7 @@ public CompletableFuture<V> retrieveLatestVersion() {
     }
 
     @Override
-    public CompletableFuture<@Unmodifiable Set<V>> retrieveVersions() {
+    public CompletableFuture<Set<V>> retrieveVersions() {
         return retrieveHangarVersions().thenApply(versions -> versions.stream()
                 .map(this::parseVersion)
                 .collect(Collectors.toUnmodifiableSet()));
@@ -76,14 +69,14 @@ public CompletableFuture<V> retrieveLatestSupportedVersion() {
     }
 
     @Override
-    public @Unmodifiable Set<V> getSupportedVersions() {
+    public Set<V> getSupportedVersions() {
         return versions.stream()
                 .filter(this::isSupported)
                 .map(this::parseVersion)
                 .collect(Collectors.toUnmodifiableSet());
     }
 
-    public @Unmodifiable Set<V> getVersions() {
+    public Set<V> getVersions() {
         return versions.stream()
                 .map(this::parseVersion)
                 .collect(Collectors.toUnmodifiableSet());

version-checker/src/main/java/core/version/hangar/HangarVersions.java

@@ -1,6 +1,9 @@
 package core.version.hangar;
 
+import org.jspecify.annotations.NullMarked;
+
 import java.util.Set;
 
+@NullMarked
 public record HangarVersions(Set<HangarVersion> result) {
 }

version-checker/src/test/java/core/version/test/implementation/GitHubSemanticVersionChecker.java

@@ -1,11 +1,11 @@
 package core.version.test.implementation;
 
-import core.annotation.TypesAreNotNullByDefault;
 import core.version.SemanticVersion;
 import core.version.github.GitHubVersionChecker;
 import core.version.github.Release;
+import org.jspecify.annotations.NullMarked;
 
-@TypesAreNotNullByDefault
+@NullMarked
 public class GitHubSemanticVersionChecker extends GitHubVersionChecker<SemanticVersion> {
     public GitHubSemanticVersionChecker(String owner, String repository) {
         super(owner, repository);