Package graphql.analysis

Class QueryTraverser.Builder

java.lang.Object

graphql.analysis.QueryTraverser.Builder

Enclosing class:

QueryTraverser

@PublicApi
public static class QueryTraverser.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueryTraverser	build()
QueryTraverser.Builder	coercedVariables(CoercedVariables coercedVariables)	Variables (already coerced) used in the query.
QueryTraverser.Builder	document(Document document)	document to be used to traverse the whole query.
QueryTraverser.Builder	fragmentsByName(Map<String,FragmentDefinition> fragmentsByName)	Fragment by name map.
QueryTraverser.Builder	operationName(String operationName)	specify the operation if a document is traversed and there are more than one operation.
QueryTraverser.Builder	options(QueryTraversalOptions options)	Sets the options to use while traversing
QueryTraverser.Builder	root(Node root)	Specify the root node for the traversal.
QueryTraverser.Builder	rootParentType(GraphQLCompositeType rootParentType)	The type of the parent of the root node.
QueryTraverser.Builder	schema(GraphQLSchema schema)	The schema used to identify the types of the query.
QueryTraverser.Builder	variables(Map<String,Object> variables)	Raw variables used in the query.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

schema

public QueryTraverser.Builder schema(GraphQLSchema schema)

The schema used to identify the types of the query.

Parameters:

schema - the schema to use

Returns:

this builder

operationName

public QueryTraverser.Builder operationName(String operationName)

specify the operation if a document is traversed and there are more than one operation.

Parameters:

operationName - the operation name to use

Returns:

this builder

document

public QueryTraverser.Builder document(Document document)

document to be used to traverse the whole query. If set a operationName(String) might be required.

Parameters:

document - the document to use

Returns:

this builder

variables

public QueryTraverser.Builder variables(Map<String,Object> variables)

Raw variables used in the query.

Parameters:

variables - the variables to use

Returns:

this builder

coercedVariables

public QueryTraverser.Builder coercedVariables(CoercedVariables coercedVariables)

Variables (already coerced) used in the query.

Parameters:

coercedVariables - the variables to use

Returns:

this builder

root

public QueryTraverser.Builder root(Node root)

Specify the root node for the traversal. Needs to be provided if there is no document(Document).

Parameters:

root - the root node to use

Returns:

this builder

rootParentType

public QueryTraverser.Builder rootParentType(GraphQLCompositeType rootParentType)

The type of the parent of the root node. (See root(Node)

Parameters:

rootParentType - the root parent type

Returns:

this builder

fragmentsByName

public QueryTraverser.Builder fragmentsByName(Map<String,FragmentDefinition> fragmentsByName)

Fragment by name map. Needs to be provided together with a root(Node) and rootParentType(GraphQLCompositeType)

Parameters:

fragmentsByName - the map of fragments

Returns:

this builder

options

public QueryTraverser.Builder options(QueryTraversalOptions options)

Sets the options to use while traversing

Parameters:

options - the options to use

Returns:

this builder

build

public QueryTraverser build()

Returns:

a built QueryTraverser object