Package graphql.language
Class 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:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionalternative to using a Builder for convenienceField
(String name, SelectionSet selectionSet) alternative to using a Builder for convenienceprotected
Field
(String name, String alias, List<Argument> arguments, List<Directive> directives, SelectionSet selectionSet, SourceLocation sourceLocation, List<Comment> comments, IgnoredChars ignoredChars, Map<String, String> additionalData) alternative to using a Builder for convenienceField
(String name, List<Argument> arguments, SelectionSet selectionSet) alternative to using a Builder for convenience -
Method Summary
Modifier and TypeMethodDescriptionaccept
(TraverserContext<Node> context, NodeVisitor visitor) Double-dispatch entry point.deepCopy()
getAlias()
This will return a list of all the directives that have been put onNode
as a flat list, which may contain repeatable and non repeatable directives.getDirectives
(String directiveName) Returns all the directives with the provided name, including repeatable and non repeatable directives.This will return a Map of the all directives that are associated with aNode
, including both repeatable and non repeatable directives.getName()
Alternative toNode.getChildren()
where the children are not all in one list regardless of type but grouped by name/type of the child.boolean
hasDirective
(String directiveName) This returns true if the AST node contains one or more directives by the specified nameboolean
Compares just the content and not the children.static Field.Builder
newField()
static Field.Builder
static Field.Builder
newField
(String name, SelectionSet selectionSet) toString()
transform
(Consumer<Field.Builder> builderConsumer) withNewChildren
(NodeChildrenContainer newChildren) Replaces the specified children and returns a new Node.Methods inherited from class graphql.language.AbstractNode
deepCopy, deepCopy, getAdditionalData, getComments, getIgnoredChars, getSourceLocation
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface graphql.language.Node
getAdditionalData, getComments, getIgnoredChars, getSourceLocation
-
Field Details
-
CHILD_ARGUMENTS
- See Also:
-
CHILD_DIRECTIVES
- See Also:
-
CHILD_SELECTION_SET
- See Also:
-
-
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
alternative to using a Builder for convenience- Parameters:
name
- of the field
-
Field
alternative to using a Builder for convenience- Parameters:
name
- of the fieldarguments
- to the field
-
Field
alternative to using a Builder for convenience- Parameters:
name
- of the fieldarguments
- to the fieldselectionSet
- of the field
-
Field
alternative to using a Builder for convenience- Parameters:
name
- of the fieldselectionSet
- of the field
-
-
Method Details
-
getChildren
- Specified by:
getChildren
in interfaceNode<Field>
- Returns:
- a list of the children of this node
-
getNamedChildren
Description copied from interface:Node
Alternative toNode.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 interfaceNode<Field>
- Returns:
- a container of the child nodes
-
withNewChildren
Description copied from interface:Node
Replaces the specified children and returns a new Node.- Specified by:
withNewChildren
in interfaceNode<Field>
- Parameters:
newChildren
- must be empty for Nodes without children- Returns:
- a new node
-
getName
-
getAlias
-
getResultKey
-
getArguments
-
getDirectives
Description copied from interface:DirectivesContainer
This will return a list of all the directives that have been put onNode
as a flat list, which may contain repeatable and non repeatable directives.- Specified by:
getDirectives
in interfaceDirectivesContainer<Field>
- Returns:
- a list of all the directives associated with this Node
-
getDirectivesByName
Description copied from interface:DirectivesContainer
This will return a Map of the all directives that are associated with aNode
, including both repeatable and non repeatable directives.- Specified by:
getDirectivesByName
in interfaceDirectivesContainer<Field>
- Returns:
- a map of all directives by directive name
-
getDirectives
Description copied from interface:DirectivesContainer
Returns all the directives with the provided name, including repeatable and non repeatable directives.- Specified by:
getDirectives
in interfaceDirectivesContainer<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
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 interfaceDirectivesContainer<Field>
- Parameters:
directiveName
- the name ot check- Returns:
- true if the AST node contains one or more directives by the specified name
-
getSelectionSet
- Specified by:
getSelectionSet
in interfaceSelectionSetContainer<Field>
-
isEqualTo
Description copied from interface:Node
Compares just the content and not the children. -
deepCopy
-
toString
-
accept
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 basedinstanceOf
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 interfaceNode<Field>
- Parameters:
context
- TraverserContext bound to this Node objectvisitor
- 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
-
newField
-
newField
-
transform
-