Package graphql.language

Class DirectiveDefinition

java.lang.Object

graphql.language.AbstractNode<DirectiveDefinition>

graphql.language.AbstractDescribedNode<DirectiveDefinition>

graphql.language.DirectiveDefinition

All Implemented Interfaces:

Definition<DirectiveDefinition>, DescribedNode<DirectiveDefinition>, NamedNode<DirectiveDefinition>, Node<DirectiveDefinition>, SDLDefinition<DirectiveDefinition>, SDLNamedDefinition<DirectiveDefinition>, Serializable

@PublicApi
public class DirectiveDefinition
extends AbstractDescribedNode<DirectiveDefinition>
implements SDLNamedDefinition<DirectiveDefinition>, NamedNode<DirectiveDefinition>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DirectiveDefinition.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILD_DIRECTIVE_LOCATION
static final String	CHILD_INPUT_VALUE_DEFINITIONS

Fields inherited from class graphql.language.AbstractDescribedNode

description

Constructor Summary

Constructors

Modifier	Constructor	Description
	DirectiveDefinition(String name)	alternative to using a Builder for convenience
protected	DirectiveDefinition(String name, boolean repeatable, Description description, List<InputValueDefinition> inputValueDefinitions, List<DirectiveLocation> directiveLocations, SourceLocation sourceLocation, List<Comment> comments, IgnoredChars ignoredChars, Map<String,String> additionalData)

Method Summary

Modifier and Type	Method	Description
TraversalControl	accept(TraverserContext<Node> context, NodeVisitor visitor)	Double-dispatch entry point.
DirectiveDefinition	deepCopy()
List<Node>	getChildren()
List<DirectiveLocation>	getDirectiveLocations()
List<InputValueDefinition>	getInputValueDefinitions()
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.
boolean	isRepeatable()	An AST node can have multiple directives associated with it IF the directive definition allows repeatable directives.
static DirectiveDefinition.Builder	newDirectiveDefinition()
String	toString()
DirectiveDefinition	transform(Consumer<DirectiveDefinition.Builder> builderConsumer)
DirectiveDefinition	withNewChildren(NodeChildrenContainer newChildren)	Replaces the specified children and returns a new Node.

Methods inherited from class graphql.language.AbstractDescribedNode

getDescription

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_INPUT_VALUE_DEFINITIONS

public static final String CHILD_INPUT_VALUE_DEFINITIONS

See Also:

• Constant Field Values

CHILD_DIRECTIVE_LOCATION

public static final String CHILD_DIRECTIVE_LOCATION

See Also:

• Constant Field Values

Constructor Details

DirectiveDefinition

protected DirectiveDefinition(String name,
 boolean repeatable,
 Description description,
 List<InputValueDefinition> inputValueDefinitions,
 List<DirectiveLocation> directiveLocations,
 SourceLocation sourceLocation,
 List<Comment> comments,
 IgnoredChars ignoredChars,
 Map<String,String> additionalData)

DirectiveDefinition

public DirectiveDefinition(String name)

alternative to using a Builder for convenience

Parameters:

name - of the directive definition

Method Details

getName

public String getName()

Specified by:

getName in interface NamedNode<DirectiveDefinition>

Specified by:

getName in interface SDLNamedDefinition<DirectiveDefinition>

Returns:

The name of this SDL definition

isRepeatable

public boolean isRepeatable()

An AST node can have multiple directives associated with it IF the directive definition allows repeatable directives.

Returns:

true if this directive definition allows repeatable directives

getInputValueDefinitions

public List<InputValueDefinition> getInputValueDefinitions()

getDirectiveLocations

public List<DirectiveLocation> getDirectiveLocations()

getChildren

public List<Node> getChildren()

Specified by:

getChildren in interface Node<DirectiveDefinition>

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<DirectiveDefinition>

Returns:

a container of the child nodes

withNewChildren

public DirectiveDefinition withNewChildren(NodeChildrenContainer newChildren)

Description copied from interface: Node

Replaces the specified children and returns a new Node.

Specified by:

withNewChildren in interface Node<DirectiveDefinition>

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<DirectiveDefinition>

Parameters:

o - the other node to compare to

Returns:

isEqualTo

deepCopy

public DirectiveDefinition deepCopy()

Specified by:

deepCopy in interface Node<DirectiveDefinition>

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<DirectiveDefinition>

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.

newDirectiveDefinition

public static DirectiveDefinition.Builder newDirectiveDefinition()

transform

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