graphql.language

Class Document

java.lang.Object

graphql.language.AbstractNode<Document>

graphql.language.Document

All Implemented Interfaces:

Node<Document>, java.io.Serializable

@PublicApi
public class Document
extends AbstractNode<Document>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
	Document(java.util.List<Definition> definitions) alternative to using a Builder for convenience
protected	Document(java.util.List<Definition> definitions, SourceLocation sourceLocation, java.util.List<Comment> comments)

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<Node> context, NodeVisitor visitor) Double-dispatch entry point.
Document	deepCopy()
java.util.List<Node>	getChildren()
java.util.List<Definition>	getDefinitions()
boolean	isEqualTo(Node o) Compares just the content and not the children.
static Document.Builder	newDocument()
java.lang.String	toString()
Document	transform(java.util.function.Consumer<Document.Builder> builderConsumer)

Methods inherited from class graphql.language.AbstractNode

deepCopy, deepCopy, getComments, getSourceLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

protected Document(java.util.List<Definition> definitions,
                   SourceLocation sourceLocation,
                   java.util.List<Comment> comments)

Document

public Document(java.util.List<Definition> definitions)

alternative to using a Builder for convenience

Method Detail

getDefinitions

public java.util.List<Definition> getDefinitions()

getChildren

public java.util.List<Node> getChildren()

Returns:

a list of the children of this node

isEqualTo

public boolean isEqualTo(Node o)

Description copied from interface: Node

Compares just the content and not the children.

Parameters:

o - the other node to compare to

Returns:

isEqualTo

deepCopy

public Document deepCopy()

Returns:

a deep copy of this node

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

accept

public TraversalControl accept(TraverserContext<Node> context,
                               NodeVisitor visitor)

Description copied from interface: Node

Double-dispatch entry point. A node receives a Visitor instance and then calls a method on a Visitor that corresponds to a actual type of this Node. This binding however happens at the compile time and therefore it allows to save on rather expensive reflection based instanceOf check when decision based on the actual type of Node is needed, which happens redundantly during traversing AST. Additional advantage of this pattern is to decouple tree traversal mechanism from the code that needs to be executed when traversal "visits" a particular Node in the tree. This leads to a better code re-usability and maintainability.

Parameters:

context - TraverserContext bound to this Node object

visitor - Visitor instance that performs actual processing on the Nodes(s)

Returns:

Result of Visitor's operation. Note! Visitor's operation might return special results to control traversal process.

newDocument

public static Document.Builder newDocument()

transform

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