Package graphql.language

Class VariableReference

java.lang.Object
graphql.language.AbstractNode<VariableReference>
graphql.language.VariableReference
All Implemented Interfaces:
NamedNode<VariableReference>, Node<VariableReference>, Value<VariableReference>, Serializable
@PublicApi public class VariableReference extends AbstractNode<VariableReference> implements Value<VariableReference>, NamedNode<VariableReference>
See Also:

  • Constructor Details

    • VariableReference

      protected VariableReference(String name, SourceLocation sourceLocation, List<Comment> comments, IgnoredChars ignoredChars, Map<String,String> additionalData)

    • VariableReference

      public VariableReference(String name)
      alternative to using a Builder for convenience
      Parameters:
      name - of the variable

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface NamedNode<VariableReference>
      Returns:
      the name of this node

    • getChildren

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

    • withNewChildren

      public VariableReference withNewChildren(NodeChildrenContainer newChildren)
      Description copied from interface: Node
      Replaces the specified children and returns a new Node.
      Specified by:
      withNewChildren in interface Node<VariableReference>
      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.
      Specified by:
      isEqualTo in interface Node<VariableReference>
      Parameters:
      o - the other node to compare to
      Returns:
      isEqualTo

    • deepCopy

      public VariableReference deepCopy()
      Specified by:
      deepCopy in interface Node<VariableReference>
      Returns:
      a deep copy of this node

    • toString

      public String toString()
      Overrides:
      toString in class 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<VariableReference>
      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.

    • of

      public static VariableReference of(String name)

    • newVariableReference

      public static VariableReference.Builder newVariableReference()

    • transform

      public VariableReference transform(Consumer<VariableReference.Builder> builderConsumer)