graphql.parser

Class ParserOptions

java.lang.Object

graphql.parser.ParserOptions

@PublicApi
public class ParserOptions
extends java.lang.Object

Options that control how the Parser behaves.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParserOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_QUERY_TOKENS An graphql hacking vector is to send nonsensical queries that burn lots of parsing CPU time and burn memory representing a document that wont ever execute.

Method Summary

Modifier and Type	Method and Description
static ParserOptions	getDefaultParserOptions() By default the Parser will not capture ignored characters.
int	getMaxTokens() A graphql hacking vector is to send nonsensical queries that burn lots of parsing CPU time and burn memory representing a document that won't ever execute.
ParsingListener	getParsingListener()
boolean	isCaptureIgnoredChars() Significant memory savings can be made if we do NOT capture ignored characters, especially in SDL parsing.
boolean	isCaptureLineComments() Single-line Comments do not have any semantic meaning in GraphQL source documents, as such you may wish to ignore them.
boolean	isCaptureSourceLocation() Memory savings can be made if we do NOT set SourceLocations on AST nodes, especially in SDL parsing.
static ParserOptions.Builder	newParserOptions()
static void	setDefaultParserOptions(ParserOptions options) By default the Parser will not capture ignored characters.
ParserOptions	transform(java.util.function.Consumer<ParserOptions.Builder> builderConsumer)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_QUERY_TOKENS

public static final int MAX_QUERY_TOKENS

An graphql hacking vector is to send nonsensical queries that burn lots of parsing CPU time and burn memory representing a document that wont ever execute. To prevent this for most users, graphql-java set this value to 15000. ANTLR parsing time is linear to the number of tokens presented. The more you allow the longer it takes. If you want to allow more, then setDefaultParserOptions(ParserOptions) allows you to change this JVM wide.

See Also:

Constant Field Values

Method Detail

getDefaultParserOptions

public static ParserOptions getDefaultParserOptions()

By default the Parser will not capture ignored characters. A static holds this default value in a JVM wide basis options object. Significant memory savings can be made if we do NOT capture ignored characters, especially in SDL parsing.

Returns:

the static default value on whether to capture ignored chars

See Also:

IgnoredChar, SourceLocation

setDefaultParserOptions

public static void setDefaultParserOptions(ParserOptions options)

By default the Parser will not capture ignored characters. A static holds this default value in a JVM wide basis options object. Significant memory savings can be made if we do NOT capture ignored characters, especially in SDL parsing. So we have set this to false by default. This static can be set to true to allow the behavior of version 16.x or before.

Parameters:

options - - the new default JVM parser options

See Also:

IgnoredChar, SourceLocation

isCaptureIgnoredChars

public boolean isCaptureIgnoredChars()

Significant memory savings can be made if we do NOT capture ignored characters, especially in SDL parsing. So we have set this to false by default.

Returns:

true if ignored chars should be captured as AST nodes

isCaptureSourceLocation

public boolean isCaptureSourceLocation()

Memory savings can be made if we do NOT set SourceLocations on AST nodes, especially in SDL parsing.

Returns:

true if SourceLocations should be captured as AST nodes

See Also:

SourceLocation

isCaptureLineComments

public boolean isCaptureLineComments()

Single-line Comments do not have any semantic meaning in GraphQL source documents, as such you may wish to ignore them.

This option does not ignore documentation Descriptions.

Returns:

true if Comments should be captured as AST nodes

See Also:

SourceLocation

getMaxTokens

public int getMaxTokens()

A graphql hacking vector is to send nonsensical queries that burn lots of parsing CPU time and burn memory representing a document that won't ever execute. To prevent this you can set a maximum number of parse tokens that will be accepted before an exception is thrown and the parsing is stopped.

Returns:

the maximum number of raw tokens the parser will accept, after which an exception will be thrown.

getParsingListener

public ParsingListener getParsingListener()

transform

public ParserOptions transform(java.util.function.Consumer<ParserOptions.Builder> builderConsumer)

newParserOptions

public static ParserOptions.Builder newParserOptions()