Package graphql.language

Class Directive

java.lang.Object

graphql.language.AbstractNode<Directive>

graphql.language.Directive

All Implemented Interfaces:

NamedNode<Directive>, Node<Directive>, java.io.Serializable

@PublicApi
public class Directive
extends AbstractNode<Directive>
implements NamedNode<Directive>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Directive.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CHILD_ARGUMENTS

Constructor Summary

Constructors

Modifier	Constructor	Description
	Directive(java.lang.String name)	alternative to using a Builder for convenience
	Directive(java.lang.String name, java.util.List<Argument> arguments)	alternative to using a Builder for convenience
protected	Directive(java.lang.String name, java.util.List<Argument> arguments, SourceLocation sourceLocation, java.util.List<Comment> comments, IgnoredChars ignoredChars, java.util.Map<java.lang.String,java.lang.String> additionalData)

Method Summary

Modifier and Type	Method	Description
TraversalControl	accept(TraverserContext<Node> context, NodeVisitor visitor)	Double-dispatch entry point.
Directive	deepCopy()
Argument	getArgument(java.lang.String argumentName)
java.util.List<Argument>	getArguments()
java.util.Map<java.lang.String,Argument>	getArgumentsByName()
java.util.List<Node>	getChildren()
java.lang.String	getName()
NodeChildrenContainer	getNamedChildren()	Alternative to Node.getChildren() where the children are not all in one list regardless of type but grouped by name/type of the child.
boolean	isEqualTo(Node o)	Compares just the content and not the children.
static Directive.Builder	newDirective()
java.lang.String	toString()
Directive	transform(java.util.function.Consumer<Directive.Builder> builderConsumer)
Directive	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 Detail

CHILD_ARGUMENTS

public static final java.lang.String CHILD_ARGUMENTS

See Also:

Constant Field Values

Constructor Detail

Directive

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

Directive

public Directive(java.lang.String name,
                 java.util.List<Argument> arguments)

alternative to using a Builder for convenience

Parameters:

name - of the directive

arguments - of the directive

Directive

public Directive(java.lang.String name)

alternative to using a Builder for convenience

Parameters:

name - of the directive

Method Detail

getArguments

public java.util.List<Argument> getArguments()

getArgumentsByName

public java.util.Map<java.lang.String,Argument> getArgumentsByName()

getArgument

public Argument getArgument(java.lang.String argumentName)

getName

public java.lang.String getName()

Specified by:

getName in interface NamedNode<Directive>

Returns:

the name of this node

getChildren

public java.util.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 java.lang.String toString()

Overrides:

toString in class java.lang.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(java.util.function.Consumer<Directive.Builder> builderConsumer)