Merge pull request #3895 from mk868/jspecify-idl

dondonz · web-flow · commit 7d9516a906b5 · 2025-05-11T13:35:42.000+10:00
Specify nullness for some `graphql.schema.idl` classes
diff --git a/src/main/java/graphql/Assert.java b/src/main/java/graphql/Assert.java
@@ -1,5 +1,7 @@
 package graphql;
 
+import org.jspecify.annotations.NullMarked;
+
 import java.util.Collection;
 import java.util.function.Supplier;
 import java.util.regex.Pattern;
@@ -8,6 +10,7 @@
 
 @SuppressWarnings("TypeParameterUnusedInFormals")
 @Internal
+@NullMarked
 public class Assert {
 
     public static <T> T assertNotNullWithNPE(T object, Supplier<String> msg) {
diff --git a/src/main/java/graphql/schema/idl/FieldWiringEnvironment.java b/src/main/java/graphql/schema/idl/FieldWiringEnvironment.java
@@ -6,10 +6,12 @@
 import graphql.schema.GraphQLAppliedDirective;
 import graphql.schema.GraphQLDirective;
 import graphql.schema.GraphQLOutputType;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.List;
 
 @PublicApi
+@NullMarked
 public class FieldWiringEnvironment extends WiringEnvironment {
 
     private final FieldDefinition fieldDefinition;
@@ -46,4 +48,4 @@ public List<GraphQLDirective> getDirectives() {
     public List<GraphQLAppliedDirective> getAppliedDirectives() {
         return appliedDirectives;
     }
-}
+}
diff --git a/src/main/java/graphql/schema/idl/InterfaceWiringEnvironment.java b/src/main/java/graphql/schema/idl/InterfaceWiringEnvironment.java
@@ -2,8 +2,10 @@
 
 import graphql.PublicApi;
 import graphql.language.InterfaceTypeDefinition;
+import org.jspecify.annotations.NullMarked;
 
 @PublicApi
+@NullMarked
 public class InterfaceWiringEnvironment extends WiringEnvironment {
 
     private final InterfaceTypeDefinition interfaceTypeDefinition;
@@ -16,4 +18,4 @@ public class InterfaceWiringEnvironment extends WiringEnvironment {
     public InterfaceTypeDefinition getInterfaceTypeDefinition() {
         return interfaceTypeDefinition;
     }
-}
+}
diff --git a/src/main/java/graphql/schema/idl/ScalarInfo.java b/src/main/java/graphql/schema/idl/ScalarInfo.java
@@ -6,6 +6,7 @@
 import graphql.Scalars;
 import graphql.language.ScalarTypeDefinition;
 import graphql.schema.GraphQLScalarType;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.List;
 import java.util.Map;
@@ -14,6 +15,7 @@
  * Info on all the standard scalar objects provided by graphql-java
  */
 @PublicApi
+@NullMarked
 public class ScalarInfo {
 
     /**
diff --git a/src/main/java/graphql/schema/idl/ScalarWiringEnvironment.java b/src/main/java/graphql/schema/idl/ScalarWiringEnvironment.java
@@ -3,10 +3,12 @@
 import graphql.PublicApi;
 import graphql.language.ScalarTypeDefinition;
 import graphql.language.ScalarTypeExtensionDefinition;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.List;
 
 @PublicApi
+@NullMarked
 public class ScalarWiringEnvironment extends WiringEnvironment {
 
     private final ScalarTypeDefinition scalarTypeDefinition;
diff --git a/src/main/java/graphql/schema/idl/SchemaParser.java b/src/main/java/graphql/schema/idl/SchemaParser.java
@@ -12,6 +12,8 @@
 import graphql.parser.ParserOptions;
 import graphql.schema.idl.errors.NonSDLDefinitionError;
 import graphql.schema.idl.errors.SchemaProblem;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.io.File;
 import java.io.IOException;
@@ -32,6 +34,7 @@
  * definitions ready to be placed into {@link SchemaGenerator} say
  */
 @PublicApi
+@NullMarked
 public class SchemaParser {
 
     /**
@@ -87,7 +90,7 @@ public TypeDefinitionRegistry parse(Reader reader) throws SchemaProblem {
      *
      * @throws SchemaProblem if there are problems compiling the schema definitions
      */
-    public TypeDefinitionRegistry parse(Reader reader, ParserOptions parserOptions) throws SchemaProblem {
+    public TypeDefinitionRegistry parse(Reader reader, @Nullable ParserOptions parserOptions) throws SchemaProblem {
         try (Reader input = reader) {
             return parseImpl(input, parserOptions);
         } catch (IOException e) {
@@ -113,7 +116,7 @@ public TypeDefinitionRegistry parseImpl(Reader schemaInput) {
         return parseImpl(schemaInput, null);
     }
 
-    private TypeDefinitionRegistry parseImpl(Reader schemaInput, ParserOptions parseOptions) {
+    private TypeDefinitionRegistry parseImpl(Reader schemaInput, @Nullable ParserOptions parseOptions) {
         try {
             if (parseOptions == null) {
                 parseOptions = ParserOptions.getDefaultSdlParserOptions();
diff --git a/src/main/java/graphql/schema/idl/TypeDefinitionRegistry.java b/src/main/java/graphql/schema/idl/TypeDefinitionRegistry.java
@@ -27,6 +27,8 @@
 import graphql.schema.idl.errors.SchemaRedefinitionError;
 import graphql.schema.idl.errors.TypeRedefinitionError;
 import graphql.util.FpKit;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.io.Serializable;
 import java.util.ArrayList;
@@ -49,6 +51,7 @@
  */
 @SuppressWarnings("rawtypes")
 @PublicApi
+@NullMarked
 public class TypeDefinitionRegistry implements Serializable {
 
     private final Map<String, List<ObjectTypeExtensionDefinition>> objectTypeExtensions = new LinkedHashMap<>();
@@ -61,7 +64,7 @@ public class TypeDefinitionRegistry implements Serializable {
     private final Map<String, TypeDefinition> types = new LinkedHashMap<>();
     private final Map<String, ScalarTypeDefinition> scalarTypes = new LinkedHashMap<>();
     private final Map<String, DirectiveDefinition> directiveDefinitions = new LinkedHashMap<>();
-    private SchemaDefinition schema;
+    private @Nullable SchemaDefinition schema;
     private final List<SchemaExtensionDefinition> schemaExtensionDefinitions = new ArrayList<>();
     private final SchemaParseOrder schemaParseOrder = new SchemaParseOrder();
 
diff --git a/src/main/java/graphql/schema/idl/UnionWiringEnvironment.java b/src/main/java/graphql/schema/idl/UnionWiringEnvironment.java
@@ -2,8 +2,10 @@
 
 import graphql.PublicApi;
 import graphql.language.UnionTypeDefinition;
+import org.jspecify.annotations.NullMarked;
 
 @PublicApi
+@NullMarked
 public class UnionWiringEnvironment extends WiringEnvironment {
 
     private final UnionTypeDefinition unionTypeDefinition;
@@ -16,4 +18,4 @@ public class UnionWiringEnvironment extends WiringEnvironment {
     public UnionTypeDefinition getUnionTypeDefinition() {
         return unionTypeDefinition;
     }
-}
+}
diff --git a/src/main/java/graphql/schema/idl/WiringEnvironment.java b/src/main/java/graphql/schema/idl/WiringEnvironment.java
@@ -2,8 +2,10 @@
 
 
 import graphql.PublicApi;
+import org.jspecify.annotations.NullMarked;
 
 @PublicApi
+@NullMarked
 abstract class WiringEnvironment {
 
     private final TypeDefinitionRegistry registry;
