Package graphql.language

Class Field

    • Constructor Detail

      • Field

        protected Field​(java.lang.String name,
                java.lang.String alias,
                java.util.List<Argument> arguments,
                java.util.List<Directive> directives,
                SelectionSet selectionSet,
                SourceLocation sourceLocation,
                java.util.List<Comment> comments,
                IgnoredChars ignoredChars,
                java.util.Map<java.lang.String,​java.lang.String> additionalData)

      • Field

        public Field​(java.lang.String name)
        alternative to using a Builder for convenience
        Parameters:
        name - of the field

      • Field

        public Field​(java.lang.String name,
             java.util.List<Argument> arguments)
        alternative to using a Builder for convenience
        Parameters:
        name - of the field
        arguments - to the field

      • Field

        public Field​(java.lang.String name,
             java.util.List<Argument> arguments,
             SelectionSet selectionSet)
        alternative to using a Builder for convenience
        Parameters:
        name - of the field
        arguments - to the field
        selectionSet - of the field

      • Field

        public Field​(java.lang.String name,
             SelectionSet selectionSet)
        alternative to using a Builder for convenience
        Parameters:
        name - of the field
        selectionSet - of the field

    • Method Detail

      • getChildren

        public java.util.List<Node> getChildren()
        Specified by:
        getChildren in interface Node<Field>
        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.
        Specified by:
        getNamedChildren in interface Node<Field>
        Returns:
        a container of the child nodes

      • withNewChildren

        public Field withNewChildren​(NodeChildrenContainer newChildren)
        Description copied from interface: Node
        Replaces the specified children and returns a new Node.
        Specified by:
        withNewChildren in interface Node<Field>
        Parameters:
        newChildren - must be empty for Nodes without children
        Returns:
        a new node

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface NamedNode<Field>
        Returns:
        the name of this node

      • getAlias

        public java.lang.String getAlias()

      • getResultKey

        public java.lang.String getResultKey()

      • getArguments

        public java.util.List<Argument> getArguments()

      • getDirectives

        public java.util.List<Directive> getDirectives()
        Description copied from interface: DirectivesContainer
        This will return a list of all the directives that have been put on Node as a flat list, which may contain repeatable and non repeatable directives.
        Specified by:
        getDirectives in interface DirectivesContainer<Field>
        Returns:
        a list of all the directives associated with this Node

      • isEqualTo

        public boolean isEqualTo​(Node o)
        Description copied from interface: Node
        Compares just the content and not the children.
        Specified by:
        isEqualTo in interface Node<Field>
        Parameters:
        o - the other node to compare to
        Returns:
        isEqualTo

      • deepCopy

        public Field deepCopy()
        Specified by:
        deepCopy in interface Node<Field>
        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.
        Specified by:
        accept in interface Node<Field>
        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.

      • newField

        public static Field.Builder newField​(java.lang.String name)

      • transform

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