Package graphql.schema.idl

Class SchemaParser

java.lang.Object

graphql.schema.idl.SchemaParser

@PublicApi
@NullMarked
public class SchemaParser
extends java.lang.Object

This can take a graphql schema definition and parse it into a TypeDefinitionRegistry of definitions ready to be placed into SchemaGenerator say

Constructor Summary

Constructors

Constructor	Description
SchemaParser()

Method Summary

Modifier and Type	Method	Description
TypeDefinitionRegistry	buildRegistry(Document document)	special method to build directly a TypeDefinitionRegistry from a Document useful for Introspection => IDL (Document) => TypeDefinitionRegistry
TypeDefinitionRegistry	parse(java.io.File file)	Parse a file of schema definitions and create a TypeDefinitionRegistry
TypeDefinitionRegistry	parse(java.io.InputStream inputStream)	Parse a inputStream of schema definitions and create a TypeDefinitionRegistry
TypeDefinitionRegistry	parse(java.io.Reader reader)	Parse a reader of schema definitions and create a TypeDefinitionRegistry
TypeDefinitionRegistry	parse(java.io.Reader reader, @Nullable ParserOptions parserOptions)	Parse a reader of schema definitions and create a TypeDefinitionRegistry
TypeDefinitionRegistry	parse(java.lang.String schemaInput)	Parse a string of schema definitions and create a TypeDefinitionRegistry
TypeDefinitionRegistry	parseImpl(java.io.Reader schemaInput)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaParser

public SchemaParser()

Method Detail

parse

public TypeDefinitionRegistry parse(java.io.File file)
                             throws SchemaProblem

Parse a file of schema definitions and create a TypeDefinitionRegistry

Parameters:

file - the file to parse

Returns:

registry of type definitions

Throws:

SchemaProblem - if there are problems compiling the schema definitions

parse

public TypeDefinitionRegistry parse(java.io.InputStream inputStream)
                             throws SchemaProblem

Parse a inputStream of schema definitions and create a TypeDefinitionRegistry

Parameters:

inputStream - the inputStream to parse

Returns:

registry of type definitions

Throws:

SchemaProblem - if there are problems compiling the schema definitions

parse

public TypeDefinitionRegistry parse(java.io.Reader reader)
                             throws SchemaProblem

Parse a reader of schema definitions and create a TypeDefinitionRegistry

Parameters:

reader - the reader to parse

Returns:

registry of type definitions

Throws:

SchemaProblem - if there are problems compiling the schema definitions

parse

public TypeDefinitionRegistry parse(java.io.Reader reader,
                                    @Nullable ParserOptions parserOptions)
                             throws SchemaProblem

Parse a reader of schema definitions and create a TypeDefinitionRegistry

Parameters:

reader - the reader to parse

parserOptions - the parse options to use while parsing

Returns:

registry of type definitions

Throws:

SchemaProblem - if there are problems compiling the schema definitions

parse

public TypeDefinitionRegistry parse(java.lang.String schemaInput)
                             throws SchemaProblem

Parse a string of schema definitions and create a TypeDefinitionRegistry

Parameters:

schemaInput - the schema string to parse

Returns:

registry of type definitions

Throws:

SchemaProblem - if there are problems compiling the schema definitions

parseImpl

public TypeDefinitionRegistry parseImpl(java.io.Reader schemaInput)

buildRegistry

public TypeDefinitionRegistry buildRegistry(Document document)

special method to build directly a TypeDefinitionRegistry from a Document useful for Introspection => IDL (Document) => TypeDefinitionRegistry

Parameters:

document - containing type definitions

Returns:

the TypeDefinitionRegistry containing all type definitions from the document

Throws:

SchemaProblem - if an error occurs