Package graphql.language

Class Document

    • Field Detail

      • CHILD_DEFINITIONS

        public static final java.lang.String CHILD_DEFINITIONS
        See Also:
        Constant Field Values

    • Constructor Detail

      • Document

        protected Document​(java.util.List<Definition> definitions,
                   SourceLocation sourceLocation,
                   java.util.List<Comment> comments,
                   IgnoredChars ignoredChars,
                   java.util.Map<java.lang.String,​java.lang.String> additionalData)

      • Document

        public Document​(java.util.List<Definition> definitions)
        alternative to using a Builder for convenience
        Parameters:
        definitions - the definitions that make up this document

    • Method Detail

      • getDefinitions

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

      • getDefinitionsOfType

        public <T extends Definition> java.util.List<T> getDefinitionsOfType​(java.lang.Class<T> definitionClass)
        Returns a list of definitions of the specific type. It uses Class.isAssignableFrom(Class) for the test
        Type Parameters:
        T - the type of definition
        Parameters:
        definitionClass - the definition class
        Returns:
        a list of definitions of that class or empty list

      • getFirstDefinitionOfType

        public <T extends Definition> java.util.Optional<T> getFirstDefinitionOfType​(java.lang.Class<T> definitionClass)
        Returns the first of the specific type. It uses Class.isAssignableFrom(Class) for the test. This is useful when you have generated a document in code and KNOW there is only one definition in it
        Type Parameters:
        T - the type of definition
        Parameters:
        definitionClass - the definition class
        Returns:
        an optional definition which will be empty of there are none

      • getOperationDefinition

        public java.util.Optional<OperationDefinition> getOperationDefinition​(java.lang.String name)
        This will allow you to find a OperationDefinition with the specified name in the document
        Parameters:
        name - the name of the operation to find
        Returns:
        an optional OperationDefinition

      • getChildren

        public java.util.List<Node> getChildren()
        Returns:
        a list of the children of this node

      • getNamedChildren

        public NodeChildrenContainer getNamedChildren()
        Description copied from interface: Node
        Alternative to Node.getChildren() where the children are not all in one list regardless of type but grouped by name/type of the child.
        Returns:
        a container of the child nodes

      • withNewChildren

        public Document withNewChildren​(NodeChildrenContainer newChildren)
        Description copied from interface: Node
        Replaces the specified children and returns a new Node.
        Parameters:
        newChildren - must be empty for Nodes without children
        Returns:
        a new 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.