Skip to content

Specify nullness for some graphql.schema.idl classes #3895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dondonz merged 3 commits into from
May 11, 2025
Merged

Specify nullness for some graphql.schema.idl classes #3895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6fe11d3
Specify nullness for graphql.schema.idl classes
mk868 Apr 5, 2025
551c0d8
graphql.Assert parameters marked as non-null
mk868 Apr 7, 2025
6527779
Apply @Nullable on TypeDefinitionRegistry#schema
mk868 Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/main/java/graphql/Assert.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -8,6 +10,7 @@

@SuppressWarnings("TypeParameterUnusedInFormals")
@Internal
@NullMarked
public class Assert {

public static <T> T assertNotNullWithNPE(T object, Supplier<String> msg) {
Expand Down
4 changes: 3 additions & 1 deletion src/main/java/graphql/schema/idl/FieldWiringEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -46,4 +48,4 @@ public List<GraphQLDirective> getDirectives() {
public List<GraphQLAppliedDirective> getAppliedDirectives() {
return appliedDirectives;
}
}
}
4 changes: 3 additions & 1 deletion src/main/java/graphql/schema/idl/InterfaceWiringEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -16,4 +18,4 @@ public class InterfaceWiringEnvironment extends WiringEnvironment {
public InterfaceTypeDefinition getInterfaceTypeDefinition() {
return interfaceTypeDefinition;
}
}
}
2 changes: 2 additions & 0 deletions src/main/java/graphql/schema/idl/ScalarInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -14,6 +15,7 @@
* Info on all the standard scalar objects provided by graphql-java
*/
@PublicApi
@NullMarked
public class ScalarInfo {

/**
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/graphql/schema/idl/ScalarWiringEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/graphql/schema/idl/SchemaParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -32,6 +34,7 @@
* definitions ready to be placed into {@link SchemaGenerator} say
*/
@PublicApi
@NullMarked
public class SchemaParser {

/**
Expand Down Expand Up @@ -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) {
Expand All @@ -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();
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/graphql/schema/idl/TypeDefinitionRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -49,6 +51,7 @@
*/
@SuppressWarnings("rawtypes")
@PublicApi
@NullMarked
public class TypeDefinitionRegistry implements Serializable {

private final Map<String, List<ObjectTypeExtensionDefinition>> objectTypeExtensions = new LinkedHashMap<>();
Expand All @@ -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();

Expand Down
4 changes: 3 additions & 1 deletion src/main/java/graphql/schema/idl/UnionWiringEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -16,4 +18,4 @@ public class UnionWiringEnvironment extends WiringEnvironment {
public UnionTypeDefinition getUnionTypeDefinition() {
return unionTypeDefinition;
}
}
}
2 changes: 2 additions & 0 deletions src/main/java/graphql/schema/idl/WiringEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@


import graphql.PublicApi;
import org.jspecify.annotations.NullMarked;

@PublicApi
@NullMarked
abstract class WiringEnvironment {

private final TypeDefinitionRegistry registry;
Expand Down
Loading