Interface GraphQlSource

public interface GraphQlSource

Strategy to resolve a GraphQL and a GraphQLSchema.

This contract also includes a GraphQlSource builder encapsulating the initialization of the GraphQL instance and associated GraphQLSchema.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GraphQlSource.Builder<B extends GraphQlSource.Builder<B>>	Common configuration options for all GraphQlSource builders, independent of how GraphQLSchema is created.
static interface	GraphQlSource.Factory	Strategy to create the GraphQlSource instance in GraphQlSource.Builder.build().
static interface	GraphQlSource.SchemaResourceBuilder	GraphQlSource builder that relies on parsing schema definition files and uses a RuntimeWiring to create the underlying GraphQLSchema.

Method Summary

Modifier and Type	Method	Description
static GraphQlSource.Builder<?>	builder(graphql.schema.GraphQLSchema schema)	Return a GraphQlSource builder that uses an externally prepared GraphQLSchema.
graphql.GraphQL	graphQl()	Return the GraphQL to use.
graphql.schema.GraphQLSchema	schema()	Return the GraphQLSchema used by the current GraphQL.
static GraphQlSource.SchemaResourceBuilder	schemaResourceBuilder()	Return a GraphQlSource builder that parses GraphQL Schema resources and uses RuntimeWiring to create the GraphQLSchema.

Method Details

graphQl

graphql.GraphQL graphQl()

Return the GraphQL to use. This can be a cached instance or a different one from time to time (e.g. based on a reloaded schema).

schema

graphql.schema.GraphQLSchema schema()

Return the GraphQLSchema used by the current GraphQL.

schemaResourceBuilder

static GraphQlSource.SchemaResourceBuilder schemaResourceBuilder()

Return a GraphQlSource builder that parses GraphQL Schema resources and uses RuntimeWiring to create the GraphQLSchema.

builder

static GraphQlSource.Builder<?> builder(graphql.schema.GraphQLSchema schema)

Return a GraphQlSource builder that uses an externally prepared GraphQLSchema.

Parameters:

schema - the GraphQL schema