Package graphql.language

Class VariableDefinition

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

  • Field Details

  • Constructor Details

    • VariableDefinition

      protected VariableDefinition(String name, Type type, Value defaultValue, List<Directive> directives, SourceLocation sourceLocation, List<Comment> comments, IgnoredChars ignoredChars, Map<String,String> additionalData)

    • VariableDefinition

      public VariableDefinition(String name, Type type, Value defaultValue)
      alternative to using a Builder for convenience
      Parameters:
      name - of the variable
      type - of the variable
      defaultValue - of the variable

    • VariableDefinition

      public VariableDefinition(String name, Type type)
      alternative to using a Builder for convenience
      Parameters:
      name - of the variable
      type - of the variable

  • Method Details

    • getDefaultValue

      public Value getDefaultValue()

    • getName

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

    • getType

      public Type getType()

    • getDirectives

      public 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<VariableDefinition>
      Returns:
      a list of all the directives associated with this Node

    • getChildren

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

    • withNewChildren

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

    • deepCopy

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

    • newVariableDefinition

      public static VariableDefinition.Builder newVariableDefinition()

    • newVariableDefinition

      public static VariableDefinition.Builder newVariableDefinition(String name)

    • newVariableDefinition

      public static VariableDefinition.Builder newVariableDefinition(String name, Type type)

    • newVariableDefinition

      public static VariableDefinition.Builder newVariableDefinition(String name, Type type, Value defaultValue)

    • transform

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