Class Parser

java.lang.Object

graphql.parser.Parser

Direct Known Subclasses:

NodeToRuleCapturingParser

@PublicApi
public class Parser
extends Object

This can parse graphql syntax, both Query syntax and Schema Definition Language (SDL) syntax, into an Abstract Syntax Tree (AST) represented by a Document

You should not generally need to call this class as the GraphQL code sets this up for you but if you are doing specific graphql utilities this class is essential.

Graphql syntax has a series of characters, such as spaces, new lines and commas that are not considered relevant to the syntax. However they can be captured and associated with the AST elements they belong to.

This costs more memory but for certain use cases (like editors) this maybe be useful. We have chosen to no capture ignored characters by default but you can turn this on, either per parse or statically for the whole JVM via ParserOptions.setDefaultParserOptions(ParserOptions) ()}}

See Also:

• IgnoredChar

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHANNEL_COMMENTS
static final int	CHANNEL_WHITESPACE

Constructor Summary

Constructors

Constructor	Description
Parser()

Method Summary

Modifier and Type	Method	Description
protected GraphqlAntlrToLanguage	getAntlrToLanguage(org.antlr.v4.runtime.CommonTokenStream tokens, MultiSourceReader multiSourceReader, ParserEnvironment environment)	Allows you to override the ANTLR to AST code.
static Document	parse(ParserEnvironment environment)	Parses a string input into a graphql AST Document
static Document	parse(String input)	Parses a string input into a graphql AST Document
Document	parseDocument(ParserEnvironment environment)	Parses document text into a graphql AST Document
Document	parseDocument(Reader reader)	Parses reader input into a graphql AST Document
Document	parseDocument(Reader reader, ParserOptions parserOptions)	Deprecated. use {#parse(ParserEnvironment)} instead
Document	parseDocument(String input)	Parses a string input into a graphql AST Document
Document	parseDocument(String input, ParserOptions parserOptions)	Deprecated. use {#parse(ParserEnvironment)} instead
Document	parseDocument(String input, String sourceName)	Deprecated. use {#parse(ParserEnvironment)} instead
static Type<?>	parseType(String input)	Parses a string input into a graphql AST Type
static Value<?>	parseValue(String input)	Parses a string input into a graphql AST Value

Methods inherited from class Object

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

Field Details

CHANNEL_COMMENTS

public static final int CHANNEL_COMMENTS

See Also:

• Constant Field Values

CHANNEL_WHITESPACE

public static final int CHANNEL_WHITESPACE

See Also:

• Constant Field Values

Constructor Details

Parser

public Parser()

Method Details

parse

public static Document parse(ParserEnvironment environment)
                      throws InvalidSyntaxException

Parses a string input into a graphql AST Document

Parameters:

environment - the parser environment to use

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the document is not valid graphql syntax

parse

public static Document parse(String input)
                      throws InvalidSyntaxException

Parses a string input into a graphql AST Document

Parameters:

input - the input to parse

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseValue

public static Value<?> parseValue(String input)
                           throws InvalidSyntaxException

Parses a string input into a graphql AST Value

Parameters:

input - the input to parse

Returns:

an AST Value

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseType

public static Type<?> parseType(String input)
                         throws InvalidSyntaxException

Parses a string input into a graphql AST Type

Parameters:

input - the input to parse

Returns:

an AST Type

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseDocument

public Document parseDocument(ParserEnvironment environment)
                       throws InvalidSyntaxException

Parses document text into a graphql AST Document

Parameters:

environment - the parser environment to sue

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseDocument

public Document parseDocument(String input)
                       throws InvalidSyntaxException

Parses a string input into a graphql AST Document

Parameters:

input - the input to parse

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseDocument

public Document parseDocument(Reader reader)
                       throws InvalidSyntaxException

Parses reader input into a graphql AST Document

Parameters:

reader - the reader input to parse

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseDocument

@Deprecated
public Document parseDocument(String input,
 String sourceName)
                       throws InvalidSyntaxException

Deprecated.

use {#parse(ParserEnvironment)} instead

Parses a string input into a graphql AST Document

Parameters:

input - the input to parse

sourceName - - the name to attribute to the input text in SourceLocation.getSourceName()

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseDocument

@Deprecated
public Document parseDocument(String input,
 ParserOptions parserOptions)
                       throws InvalidSyntaxException

Deprecated.

use {#parse(ParserEnvironment)} instead

Parses a string input into a graphql AST Document

Parameters:

input - the input to parse

parserOptions - the parser options

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

parseDocument

@Deprecated
public Document parseDocument(Reader reader,
 ParserOptions parserOptions)
                       throws InvalidSyntaxException

Deprecated.

use {#parse(ParserEnvironment)} instead

Parses reader input into a graphql AST Document

Parameters:

reader - the reader input to parse

parserOptions - the parser options

Returns:

an AST Document

Throws:

InvalidSyntaxException - if the input is not valid graphql syntax

getAntlrToLanguage

protected GraphqlAntlrToLanguage getAntlrToLanguage(org.antlr.v4.runtime.CommonTokenStream tokens,
 MultiSourceReader multiSourceReader,
 ParserEnvironment environment)

Allows you to override the ANTLR to AST code.

Parameters:

tokens - the token stream

multiSourceReader - the source of the query document

environment - the parser environment

Returns:

a new GraphqlAntlrToLanguage instance