Package graphql.language

Class Field

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

  • Field Details

  • Constructor Details

    • Field

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

    • Field

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

    • Field

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

    • Field

      public Field(String name, 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(String name, SelectionSet selectionSet)
      alternative to using a Builder for convenience
      Parameters:
      name - of the field
      selectionSet - of the field

  • Method Details

    • getChildren

      public 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 String getName()
      Specified by:
      getName in interface NamedNode<Field>
      Returns:
      the name of this node

    • getAlias

      public String getAlias()

    • getResultKey

      public String getResultKey()

    • getArguments

      public List<Argument> getArguments()

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

    • getDirectivesByName

      public Map<String,List<Directive>> getDirectivesByName()
      Description copied from interface: DirectivesContainer
      This will return a Map of the all directives that are associated with a Node, including both repeatable and non repeatable directives.
      Specified by:
      getDirectivesByName in interface DirectivesContainer<Field>
      Returns:
      a map of all directives by directive name

    • getDirectives

      public List<Directive> getDirectives(String directiveName)
      Description copied from interface: DirectivesContainer
      Returns all the directives with the provided name, including repeatable and non repeatable directives.
      Specified by:
      getDirectives in interface DirectivesContainer<Field>
      Parameters:
      directiveName - the name of the directives to retrieve
      Returns:
      the directives or empty list if there is not one with that name

    • hasDirective

      public boolean hasDirective(String directiveName)
      Description copied from interface: DirectivesContainer
      This returns true if the AST node contains one or more directives by the specified name
      Specified by:
      hasDirective in interface DirectivesContainer<Field>
      Parameters:
      directiveName - the name ot check
      Returns:
      true if the AST node contains one or more directives by the specified name

    • getSelectionSet

      public SelectionSet getSelectionSet()
      Specified by:
      getSelectionSet in interface SelectionSetContainer<Field>

    • 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 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<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()

    • newField

      public static Field.Builder newField(String name)

    • newField

      public static Field.Builder newField(String name, SelectionSet selectionSet)

    • transform

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