chore: switch to jspecify

Author: Machine-Maker

build.gradle.kts

@@ -67,8 +67,8 @@ allprojects {
             testImplementation(rootProject.libs.asmCommons)
         }
 
-        compileOnlyApi(rootProject.libs.checkerQual)
-        testCompileOnly(rootProject.libs.checkerQual)
+        compileOnlyApi(rootProject.libs.jspecify)
+        testCompileOnly(rootProject.libs.jspecify)
         compileOnly(rootProject.libs.jetbrainsAnnotations)
         testCompileOnly(rootProject.libs.jetbrainsAnnotations)
 
@@ -80,7 +80,7 @@ allprojects {
 
     javadocLinks {
         override(startsWithAnyOf("org.ow2.asm:asm"), JavadocLinksExtension.LinkOverride.Simple("https://asm.ow2.io/javadoc"))
-        override(rootProject.libs.checkerQual, "https://checkerframework.org/api/")
+        override(rootProject.libs.jspecify, "https://jspecify.dev/docs/api/")
     }
 }
 val mainForNewTargets = sourceSets.create("mainForNewTargets")

gradle/libs.versions.toml

@@ -9,7 +9,7 @@ jbAnnos = "26.0.2"
 [libraries]
 asm = { module = "org.ow2.asm:asm", version.ref = "asm" }
 asmCommons = { module = "org.ow2.asm:asm-commons", version.ref = "asm" }
-checkerQual = "org.checkerframework:checker-qual:3.49.4"
+jspecify = { module = "org.jspecify:jspecify", version = "1.0.0" }
 jetbrainsAnnotations = { module = "org.jetbrains:annotations", version.ref = "jbAnnos" }
 
 jupiterApi = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }

reflection-rewriter/proxy-generator/src/main/java/io/papermc/reflectionrewriter/proxygenerator/ProxyGenerator.java

@@ -8,10 +8,8 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
-import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-import org.checkerframework.framework.qual.DefaultQualifier;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 import org.objectweb.asm.ClassReader;
 import org.objectweb.asm.ClassVisitor;
 import org.objectweb.asm.ClassWriter;
@@ -41,7 +39,7 @@
 /**
  * Generates holder classes for reflection proxy instances.
  */
-@DefaultQualifier(NonNull.class)
+@NullMarked
 public final class ProxyGenerator {
     private ProxyGenerator() {
     }
@@ -164,7 +162,7 @@ private static Set<Class<?>> findParents(final Class<?> clazz) {
     }
 
     private static void findParents(final Set<Class<?>> ret, final Class<?> clazz) {
-        final @Nullable Class<?> superClass = clazz.getSuperclass();
+        final Class<?> superClass = clazz.getSuperclass();
         if (superClass != null && superClass != Object.class) {
             ret.add(superClass);
             findParents(ret, superClass);
@@ -176,7 +174,7 @@ private static void findParents(final Set<Class<?>> ret, final Class<?> clazz) {
     }
 
     private static ClassReader classReader(final String className) {
-        try (final @Nullable InputStream is = ProxyGenerator.class.getClassLoader().getResourceAsStream(className.replace('.', '/') + ".class")) {
+        try (final InputStream is = ProxyGenerator.class.getClassLoader().getResourceAsStream(className.replace('.', '/') + ".class")) {
             Objects.requireNonNull(is, () -> "Class '" + className + "'");
             return new ClassReader(is);
         } catch (final Exception ex) {
@@ -217,7 +215,7 @@ public int hashCode() {
 
     private static final class DiscoverMethodsVisitor extends ClassVisitor {
         private final List<MethodInfo> methods;
-        private @MonotonicNonNull String name;
+        private @Nullable String name;
 
         DiscoverMethodsVisitor(final int api, final @Nullable ClassVisitor visitor) {
             super(api, visitor);

reflection-rewriter/rewriter/src/main/java/io/papermc/reflectionrewriter/DefineClassRule.java

@@ -10,16 +10,13 @@
 import java.lang.constant.ClassDesc;
 import java.lang.constant.MethodTypeDesc;
 import java.util.Set;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.checker.nullness.qual.Nullable;
-import org.checkerframework.framework.qual.DefaultQualifier;
+import org.jspecify.annotations.Nullable;
 
 import static io.papermc.asm.util.DescriptorUtils.fromOwner;
 import static io.papermc.asm.util.DescriptorUtils.toOwner;
 import static io.papermc.asm.util.OpcodeUtils.isStatic;
 import static io.papermc.asm.util.OpcodeUtils.staticOp;
 
-@DefaultQualifier(NonNull.class)
 public final class DefineClassRule implements MethodRewriteRule {
     private static final Set<String> CLASS_LOADER_DESCS = Set.of(
         "([BII)Ljava/lang/Class;",
@@ -66,7 +63,7 @@ public boolean shouldProcess(final ClassProcessingContext context, final int opc
             descriptor = descriptor.insertParameterTypes(0, fromOwner("java/lang/invoke/MethodHandles$Lookup"));
             new SimpleRewrite(staticOp(isInvokeDynamic), this.proxy, name, descriptor, false, isInvokeDynamic);
         }
-        final @Nullable String superName = context.processingClassSuperClassName();
+        final String superName = context.processingClassSuperClassName();
         if (superName != null) {
             if (CLASS_LOADER_DESCS.contains(descriptor.descriptorString())
                 && this.isClassLoader(context.classInfoProvider(), superName)
@@ -120,9 +117,9 @@ private static boolean is(final ClassInfoProvider classInfoProvider, final Strin
         if (className.equals(checkForName)) {
             return true;
         }
-        final @Nullable ClassInfo info = classInfoProvider.info(className);
+        final ClassInfo info = classInfoProvider.info(className);
         if (info != null) {
-            final @Nullable String superName = info.superClassName();
+            final String superName = info.superClassName();
             if (superName != null) {
                 return is(classInfoProvider, superName, checkForName, assumeClassLoader);
             } else {

reflection-rewriter/rewriter/src/main/java/io/papermc/reflectionrewriter/EnumRule.java

@@ -8,7 +8,6 @@
 import java.lang.constant.ClassDesc;
 import java.lang.invoke.ConstantBootstraps;
 import java.util.function.Predicate;
-import org.checkerframework.checker.nullness.qual.Nullable;
 import org.objectweb.asm.ClassVisitor;
 import org.objectweb.asm.MethodVisitor;
 import org.objectweb.asm.Opcodes;
@@ -102,7 +101,7 @@ public void visitMaxs(final int maxStack, final int maxLocals) {
         public void visitMethodInsn(final int opcode, final String owner, final String name, final String descriptor, final boolean isInterface) {
             if (this.ownerPredicate.test(owner) && name.equals("valueOf") && descriptor.equals("(Ljava/lang/String;)L" + owner + ";")) {
                 // Rewrite SomeEnum.valueOf(String)
-                final @Nullable ClassInfo info = this.classInfoProvider.info(owner);
+                final ClassInfo info = this.classInfoProvider.info(owner);
                 if (info != null && info.isEnum()) {
                     // Increase max stack size for this method by one for the class parameter
                     // Note that in some cases this does not actually have to be increased (which we cannot track here),
@@ -128,7 +127,7 @@ private boolean isEnum(final String owner) {
             if (owner.equals("java/lang/Enum")) {
                 return true;
             }
-            final @Nullable ClassInfo info = this.classInfoProvider.info(owner);
+            final ClassInfo info = this.classInfoProvider.info(owner);
             return info != null && info.isEnum();
         }
     }

reflection-rewriter/rewriter/src/main/java/io/papermc/reflectionrewriter/package-info.java

@@ -0,0 +1,4 @@
+@NullMarked
+package io.papermc.reflectionrewriter;
+
+import org.jspecify.annotations.NullMarked;

reflection-rewriter/runtime/src/main/java/io/papermc/reflectionrewriter/runtime/AbstractDefaultRulesReflectionProxy.java

@@ -11,10 +11,7 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.util.Objects;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.framework.qual.DefaultQualifier;
 
-@DefaultQualifier(NonNull.class)
 public abstract class AbstractDefaultRulesReflectionProxy implements DefaultRulesReflectionProxy {
     protected AbstractDefaultRulesReflectionProxy() {
     }
@@ -166,7 +163,7 @@ public CallSite metafactory(final MethodHandles.Lookup caller, final String inte
 
     @Override
     public CallSite altMetafactory(final MethodHandles.Lookup caller, final String interfaceMethodName, final MethodType factoryType, final Object... args) throws LambdaConversionException {
-        if (args.length < 3 || !(args[2] instanceof MethodType dynamicMethodType)) {
+        if (args.length < 3 || !(args[2] instanceof final MethodType dynamicMethodType)) {
             throw new IllegalArgumentException("illegal or missing argument");
         }
         return LambdaMetafactory.altMetafactory(caller, this.mapMethodName(factoryType.returnType(), interfaceMethodName, dynamicMethodType.parameterArray()), factoryType, args);

reflection-rewriter/runtime/src/main/java/io/papermc/reflectionrewriter/runtime/DefaultRulesReflectionProxy.java

@@ -8,8 +8,6 @@
 import java.lang.invoke.VarHandle;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.framework.qual.DefaultQualifier;
 
 /**
  * Interface with all the methods needed for the default rules to function.
@@ -18,7 +16,6 @@
  * should be used to generate a class with a static field holding an instance
  * of your proxy, and static methods redirecting to that instance.</p>
  */
-@DefaultQualifier(NonNull.class)
 @SuppressWarnings("checkstyle:MethodName") // These methods have their names copied from the method we are proxying
 public interface DefaultRulesReflectionProxy {
     // Begin standard reflection

reflection-rewriter/runtime/src/main/java/io/papermc/reflectionrewriter/runtime/DefineClassReflectionProxyImpl.java

@@ -10,7 +10,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Function;
-import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jspecify.annotations.Nullable;
 
 final class DefineClassReflectionProxyImpl implements DefineClassReflectionProxy {
     private static final MethodHandles.Lookup LOOKUP = MethodHandles.lookup();

reflection-rewriter/runtime/src/main/java/io/papermc/reflectionrewriter/runtime/EnumRuleReflectionProxy.java

@@ -1,14 +1,11 @@
 package io.papermc.reflectionrewriter.runtime;
 
 import java.lang.invoke.MethodHandles;
-import org.checkerframework.checker.nullness.qual.NonNull;
-import org.checkerframework.framework.qual.DefaultQualifier;
 
 /**
  * Has required methods for the non-default enum rule. Implement in addition to
  * {@link DefaultRulesReflectionProxy} if using the enum rule.
  */
-@DefaultQualifier(NonNull.class)
 public interface EnumRuleReflectionProxy {
     <E extends Enum<E>> E enumConstant(MethodHandles.Lookup lookup, String name, Class<E> type);