Package graphql.schema

Class GraphQLSchema.Builder

java.lang.Object

graphql.schema.GraphQLSchema.Builder

Enclosing class:

GraphQLSchema

@NullUnmarked
public static class GraphQLSchema.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GraphQLSchema.Builder	additionalDirective(GraphQLDirective additionalDirective)
GraphQLSchema.Builder	additionalDirectives(Set<GraphQLDirective> additionalDirectives)
GraphQLSchema.Builder	additionalType(GraphQLNamedType additionalType)	Adds a single type to the set of additional types.
GraphQLSchema.Builder	additionalTypes(Set<? extends GraphQLNamedType> additionalTypes)	Adds multiple types to the set of additional types.
GraphQLSchema	build()	Builds the schema
GraphQLSchema.Builder	clearAdditionalTypes()	Clears all additional types that have been added to this builder.
GraphQLSchema.Builder	clearSchemaDirectives()	This is used to clear all the directives in the builder so far.
GraphQLSchema.Builder	codeRegistry(GraphQLCodeRegistry codeRegistry)
GraphQLSchema.Builder	definition(SchemaDefinition definition)
GraphQLSchema.Builder	description(String description)
GraphQLSchema.Builder	extensionDefinitions(List<SchemaExtensionDefinition> extensionDefinitions)
GraphQLSchema.Builder	introspectionSchemaType(GraphQLObjectType introspectionSchemaType)
GraphQLSchema.Builder	mutation(GraphQLObjectType mutationType)
GraphQLSchema.Builder	mutation(GraphQLObjectType.Builder builder)
GraphQLSchema.Builder	query(GraphQLObjectType queryType)
GraphQLSchema.Builder	query(GraphQLObjectType.Builder builder)
GraphQLSchema.Builder	subscription(GraphQLObjectType subscriptionType)
GraphQLSchema.Builder	subscription(GraphQLObjectType.Builder builder)
GraphQLSchema.Builder	withSchemaAppliedDirective(GraphQLAppliedDirective appliedDirective)
GraphQLSchema.Builder	withSchemaAppliedDirective(GraphQLAppliedDirective.Builder builder)
GraphQLSchema.Builder	withSchemaAppliedDirectives(GraphQLAppliedDirective... appliedDirectives)
GraphQLSchema.Builder	withSchemaAppliedDirectives(Collection<? extends GraphQLAppliedDirective> appliedDirectives)
GraphQLSchema.Builder	withSchemaDirective(GraphQLDirective directive)
GraphQLSchema.Builder	withSchemaDirective(GraphQLDirective.Builder builder)
GraphQLSchema.Builder	withSchemaDirectives(GraphQLDirective... directives)
GraphQLSchema.Builder	withSchemaDirectives(Collection<? extends GraphQLDirective> directives)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

query

public GraphQLSchema.Builder query(GraphQLObjectType.Builder builder)

query

public GraphQLSchema.Builder query(GraphQLObjectType queryType)

mutation

public GraphQLSchema.Builder mutation(GraphQLObjectType.Builder builder)

mutation

public GraphQLSchema.Builder mutation(GraphQLObjectType mutationType)

subscription

public GraphQLSchema.Builder subscription(GraphQLObjectType.Builder builder)

subscription

public GraphQLSchema.Builder subscription(GraphQLObjectType subscriptionType)

codeRegistry

public GraphQLSchema.Builder codeRegistry(GraphQLCodeRegistry codeRegistry)

additionalTypes

public GraphQLSchema.Builder additionalTypes(Set<? extends GraphQLNamedType> additionalTypes)

Adds multiple types to the set of additional types.

Additional types are types that may not be directly reachable by traversing the schema from the root operation types (Query, Mutation, Subscription), but still need to be included in the schema. The most common use case is for object types that implement an interface but are not directly referenced as field return types.

Example - Adding interface implementations:

 // If Node interface is used but User/Post types aren't directly referenced:
 builder.additionalTypes(Set.of(
     GraphQLObjectType.newObject().name("User").withInterface(nodeInterface)...,
     GraphQLObjectType.newObject().name("Post").withInterface(nodeInterface)...
 ));
 

Note: There are no restrictions on what types can be added. Types already reachable from root operations can be added without causing errors - they will simply exist in both the traversed type map and this set.

Parameters:

additionalTypes - the types to add

Returns:

this builder

See Also:

• GraphQLSchema.getAdditionalTypes()

additionalType

public GraphQLSchema.Builder additionalType(GraphQLNamedType additionalType)

Adds a single type to the set of additional types.

Additional types are types that may not be directly reachable by traversing the schema from the root operation types (Query, Mutation, Subscription), but still need to be included in the schema. The most common use case is for object types that implement an interface but are not directly referenced as field return types.

Note: There are no restrictions on what types can be added. Types already reachable from root operations can be added without causing errors.

Parameters:

additionalType - the type to add

Returns:

this builder

See Also:

• GraphQLSchema.getAdditionalTypes()
• additionalTypes(Set)

clearAdditionalTypes

public GraphQLSchema.Builder clearAdditionalTypes()

Clears all additional types that have been added to this builder.

This is useful when transforming an existing schema and you want to rebuild the additional types set from scratch.

Returns:

this builder

See Also:

• additionalType(GraphQLNamedType)
• additionalTypes(Set)

additionalDirectives

public GraphQLSchema.Builder additionalDirectives(Set<GraphQLDirective> additionalDirectives)

additionalDirective

public GraphQLSchema.Builder additionalDirective(GraphQLDirective additionalDirective)

withSchemaDirectives

public GraphQLSchema.Builder withSchemaDirectives(GraphQLDirective... directives)

withSchemaDirectives

public GraphQLSchema.Builder withSchemaDirectives(Collection<? extends GraphQLDirective> directives)

withSchemaDirective

public GraphQLSchema.Builder withSchemaDirective(GraphQLDirective directive)

withSchemaDirective

public GraphQLSchema.Builder withSchemaDirective(GraphQLDirective.Builder builder)

withSchemaAppliedDirectives

public GraphQLSchema.Builder withSchemaAppliedDirectives(GraphQLAppliedDirective... appliedDirectives)

withSchemaAppliedDirectives

public GraphQLSchema.Builder withSchemaAppliedDirectives(Collection<? extends GraphQLAppliedDirective> appliedDirectives)

withSchemaAppliedDirective

public GraphQLSchema.Builder withSchemaAppliedDirective(GraphQLAppliedDirective appliedDirective)

withSchemaAppliedDirective

public GraphQLSchema.Builder withSchemaAppliedDirective(GraphQLAppliedDirective.Builder builder)

clearSchemaDirectives

public GraphQLSchema.Builder clearSchemaDirectives()

This is used to clear all the directives in the builder so far.

Returns:

the builder

definition

public GraphQLSchema.Builder definition(SchemaDefinition definition)

extensionDefinitions

public GraphQLSchema.Builder extensionDefinitions(List<SchemaExtensionDefinition> extensionDefinitions)

description

public GraphQLSchema.Builder description(String description)

introspectionSchemaType

public GraphQLSchema.Builder introspectionSchemaType(GraphQLObjectType introspectionSchemaType)

build

public GraphQLSchema build()

Builds the schema

Returns:

the built schema