Package graphql.language

Class Directive

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

  • Field Details

  • Constructor Details

    • Directive

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

    • Directive

      public Directive(String name, List<Argument> arguments)
      alternative to using a Builder for convenience
      Parameters:
      name - of the directive
      arguments - of the directive

    • Directive

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

  • Method Details

    • getArguments

      public List<Argument> getArguments()

    • getArgumentsByName

      public Map<String,Argument> getArgumentsByName()

    • getArgument

      public Argument getArgument(String argumentName)

    • getName

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

    • getChildren

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

    • withNewChildren

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

    • deepCopy

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

    • newDirective

      public static Directive.Builder newDirective()

    • transform

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