Class GraphQLSchema.Builder

java.lang.Object

graphql.schema.GraphQLSchema.Builder

Enclosing class:

GraphQLSchema

public static class GraphQLSchema.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<GraphQLDirective>	additionalDirectives
private final Set<GraphQLType>	additionalTypes
private GraphQLCodeRegistry	codeRegistry
private SchemaDefinition	definition
private String	description
private List<SchemaExtensionDefinition>	extensionDefinitions
private GraphQLObjectType	introspectionSchemaType
private GraphQLObjectType	mutationType
private GraphQLObjectType	queryType
private final List<GraphQLAppliedDirective>	schemaAppliedDirectives
private final List<GraphQLDirective>	schemaDirectives
private GraphQLObjectType	subscriptionType

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(GraphQLType additionalType)
GraphQLSchema.Builder	additionalTypes(Set<GraphQLType> additionalTypes)
GraphQLSchema	build()	Builds the schema
GraphQLSchema	build(Set<GraphQLType> additionalTypes)	Deprecated. - Use the additionalType(GraphQLType) methods
GraphQLSchema	build(Set<GraphQLType> additionalTypes, Set<GraphQLDirective> additionalDirectives)	Deprecated. - Use the additionalType(GraphQLType) and additionalDirective(GraphQLDirective) methods
private GraphQLSchema	buildImpl()
GraphQLSchema.Builder	clearAdditionalTypes()
GraphQLSchema.Builder	clearDirectives()
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	fieldVisibility(GraphqlFieldVisibility fieldVisibility)	Deprecated. use GraphQLCodeRegistry.Builder.fieldVisibility(graphql.schema.visibility.GraphqlFieldVisibility) instead
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)
private GraphQLSchema	validateSchema(GraphQLSchema graphQLSchema)
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 Object

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

Field Details

queryType

private GraphQLObjectType queryType

mutationType

private GraphQLObjectType mutationType

introspectionSchemaType

private GraphQLObjectType introspectionSchemaType

subscriptionType

private GraphQLObjectType subscriptionType

codeRegistry

private GraphQLCodeRegistry codeRegistry

definition

private SchemaDefinition definition

extensionDefinitions

private List<SchemaExtensionDefinition> extensionDefinitions

description

private String description

additionalDirectives

private final Set<GraphQLDirective> additionalDirectives

additionalTypes

private final Set<GraphQLType> additionalTypes

schemaDirectives

private final List<GraphQLDirective> schemaDirectives

schemaAppliedDirectives

private final List<GraphQLAppliedDirective> schemaAppliedDirectives

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)

fieldVisibility

@Deprecated
public GraphQLSchema.Builder fieldVisibility(GraphqlFieldVisibility fieldVisibility)

Deprecated.

use GraphQLCodeRegistry.Builder.fieldVisibility(graphql.schema.visibility.GraphqlFieldVisibility) instead

Parameters:

fieldVisibility - the field visibility

Returns:

this builder

codeRegistry

public GraphQLSchema.Builder codeRegistry(GraphQLCodeRegistry codeRegistry)

additionalTypes

public GraphQLSchema.Builder additionalTypes(Set<GraphQLType> additionalTypes)

additionalType

public GraphQLSchema.Builder additionalType(GraphQLType additionalType)

clearAdditionalTypes

public GraphQLSchema.Builder clearAdditionalTypes()

additionalDirectives

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

additionalDirective

public GraphQLSchema.Builder additionalDirective(GraphQLDirective additionalDirective)

clearDirectives

public GraphQLSchema.Builder clearDirectives()

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

@Deprecated
public GraphQLSchema build(Set<GraphQLType> additionalTypes)

Deprecated.

- Use the additionalType(GraphQLType) methods

Builds the schema

Parameters:

additionalTypes - - please don't use this anymore

Returns:

the built schema

build

@Deprecated
public GraphQLSchema build(Set<GraphQLType> additionalTypes,
 Set<GraphQLDirective> additionalDirectives)

Deprecated.

- Use the additionalType(GraphQLType) and additionalDirective(GraphQLDirective) methods

Builds the schema

Parameters:

additionalTypes - - please don't use this any more

additionalDirectives - - please don't use this any more

Returns:

the built schema

build

public GraphQLSchema build()

Builds the schema

Returns:

the built schema

buildImpl

private GraphQLSchema buildImpl()

validateSchema

private GraphQLSchema validateSchema(GraphQLSchema graphQLSchema)