Package graphql

Class GraphQL.Builder

java.lang.Object

graphql.GraphQL.Builder

Enclosing class:

GraphQL

@PublicApi
public static class GraphQL.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private DataFetcherExceptionHandler	defaultExceptionHandler
private boolean	doNotAddDefaultInstrumentations
private GraphQLSchema	graphQLSchema
private ExecutionIdProvider	idProvider
private Instrumentation	instrumentation
private ExecutionStrategy	mutationExecutionStrategy
private PreparsedDocumentProvider	preparsedDocumentProvider
private ExecutionStrategy	queryExecutionStrategy
private ExecutionStrategy	subscriptionExecutionStrategy
private ValueUnboxer	valueUnboxer

Constructor Summary

Constructors

Constructor	Description
Builder(GraphQLSchema graphQLSchema)

Method Summary

Modifier and Type	Method	Description
GraphQL	build()
GraphQL.Builder	defaultDataFetcherExceptionHandler(DataFetcherExceptionHandler dataFetcherExceptionHandler)	This allows you to set a default DataFetcherExceptionHandler that will be used to handle exceptions that happen in DataFetcher invocations.
GraphQL.Builder	doNotAddDefaultInstrumentations()	For performance reasons you can opt into situation where the default instrumentations (such as DataLoaderDispatcherInstrumentation will not be automatically added into the graphql instance.
GraphQL.Builder	executionIdProvider(ExecutionIdProvider executionIdProvider)
GraphQL.Builder	instrumentation(Instrumentation instrumentation)
GraphQL.Builder	mutationExecutionStrategy(ExecutionStrategy executionStrategy)
GraphQL.Builder	preparsedDocumentProvider(PreparsedDocumentProvider preparsedDocumentProvider)
GraphQL.Builder	queryExecutionStrategy(ExecutionStrategy executionStrategy)
GraphQL.Builder	schema(GraphQLSchema graphQLSchema)
GraphQL.Builder	subscriptionExecutionStrategy(ExecutionStrategy executionStrategy)
GraphQL.Builder	valueUnboxer(ValueUnboxer valueUnboxer)

Methods inherited from class java.lang.Object

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

Field Details

graphQLSchema

private GraphQLSchema graphQLSchema

queryExecutionStrategy

private ExecutionStrategy queryExecutionStrategy

mutationExecutionStrategy

private ExecutionStrategy mutationExecutionStrategy

subscriptionExecutionStrategy

private ExecutionStrategy subscriptionExecutionStrategy

defaultExceptionHandler

private DataFetcherExceptionHandler defaultExceptionHandler

idProvider

private ExecutionIdProvider idProvider

instrumentation

private Instrumentation instrumentation

preparsedDocumentProvider

private PreparsedDocumentProvider preparsedDocumentProvider

doNotAddDefaultInstrumentations

private boolean doNotAddDefaultInstrumentations

valueUnboxer

private ValueUnboxer valueUnboxer

Constructor Details

Builder

public Builder(GraphQLSchema graphQLSchema)

Method Details

schema

public GraphQL.Builder schema(GraphQLSchema graphQLSchema)

queryExecutionStrategy

public GraphQL.Builder queryExecutionStrategy(ExecutionStrategy executionStrategy)

mutationExecutionStrategy

public GraphQL.Builder mutationExecutionStrategy(ExecutionStrategy executionStrategy)

subscriptionExecutionStrategy

public GraphQL.Builder subscriptionExecutionStrategy(ExecutionStrategy executionStrategy)

defaultDataFetcherExceptionHandler

public GraphQL.Builder defaultDataFetcherExceptionHandler(DataFetcherExceptionHandler dataFetcherExceptionHandler)

This allows you to set a default DataFetcherExceptionHandler that will be used to handle exceptions that happen in DataFetcher invocations.

Parameters:

dataFetcherExceptionHandler - the default handler for data fetching exception

Returns:

this builder

instrumentation

public GraphQL.Builder instrumentation(Instrumentation instrumentation)

preparsedDocumentProvider

public GraphQL.Builder preparsedDocumentProvider(PreparsedDocumentProvider preparsedDocumentProvider)

executionIdProvider

public GraphQL.Builder executionIdProvider(ExecutionIdProvider executionIdProvider)

doNotAddDefaultInstrumentations

public GraphQL.Builder doNotAddDefaultInstrumentations()

For performance reasons you can opt into situation where the default instrumentations (such as DataLoaderDispatcherInstrumentation will not be automatically added into the graphql instance.

For most situations this is not needed unless you are really pushing the boundaries of performance

By default a certain graphql instrumentations will be added to the mix to more easily enable certain functionality. This allows you to stop this behavior

Returns:

this builder

valueUnboxer

public GraphQL.Builder valueUnboxer(ValueUnboxer valueUnboxer)

build

public GraphQL build()