graphql.language

Class InterfaceTypeDefinition

java.lang.Object

graphql.language.AbstractNode<T>

graphql.language.AbstractDescribedNode<InterfaceTypeDefinition>

graphql.language.InterfaceTypeDefinition

All Implemented Interfaces:

Definition<InterfaceTypeDefinition>, DescribedNode<InterfaceTypeDefinition>, DirectivesContainer<InterfaceTypeDefinition>, ImplementingTypeDefinition<InterfaceTypeDefinition>, NamedNode<InterfaceTypeDefinition>, Node<InterfaceTypeDefinition>, SDLDefinition<InterfaceTypeDefinition>, SDLExtensionDefinition, SDLNamedDefinition<InterfaceTypeDefinition>, TypeDefinition<InterfaceTypeDefinition>, java.io.Serializable

Direct Known Subclasses:

InterfaceTypeExtensionDefinition

@PublicApi
public class InterfaceTypeDefinition
extends AbstractDescribedNode<InterfaceTypeDefinition>
implements ImplementingTypeDefinition<InterfaceTypeDefinition>, DirectivesContainer<InterfaceTypeDefinition>, NamedNode<InterfaceTypeDefinition>, SDLExtensionDefinition

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InterfaceTypeDefinition.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_DEFINITIONS
static java.lang.String	CHILD_DIRECTIVES
static java.lang.String	CHILD_IMPLEMENTZ

Fields inherited from class graphql.language.AbstractDescribedNode

description

Constructor Summary

Constructors

Modifier	Constructor and Description
	InterfaceTypeDefinition(java.lang.String name) alternative to using a Builder for convenience
protected	InterfaceTypeDefinition(java.lang.String name, java.util.List<Type> implementz, java.util.List<FieldDefinition> definitions, java.util.List<Directive> directives, Description description, 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 and Description
TraversalControl	accept(TraverserContext<Node> context, NodeVisitor visitor) Double-dispatch entry point.
InterfaceTypeDefinition	deepCopy()
java.util.List<Node>	getChildren()
java.util.List<Directive>	getDirectives() 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.
java.util.List<FieldDefinition>	getFieldDefinitions()
java.util.List<Type>	getImplements()
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 InterfaceTypeDefinition.Builder	newInterfaceTypeDefinition()
java.lang.String	toString()
InterfaceTypeDefinition	transform(java.util.function.Consumer<InterfaceTypeDefinition.Builder> builderConsumer)
InterfaceTypeDefinition	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

Methods inherited from interface graphql.language.DirectivesContainer

getDirectives, getDirectivesByName, hasDirective

Field Detail

CHILD_IMPLEMENTZ

public static final java.lang.String CHILD_IMPLEMENTZ

See Also:

Constant Field Values

CHILD_DEFINITIONS

public static final java.lang.String CHILD_DEFINITIONS

See Also:

Constant Field Values

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

Constructor Detail

InterfaceTypeDefinition

protected InterfaceTypeDefinition(java.lang.String name,
                                  java.util.List<Type> implementz,
                                  java.util.List<FieldDefinition> definitions,
                                  java.util.List<Directive> directives,
                                  Description description,
                                  SourceLocation sourceLocation,
                                  java.util.List<Comment> comments,
                                  IgnoredChars ignoredChars,
                                  java.util.Map<java.lang.String,java.lang.String> additionalData)

InterfaceTypeDefinition

public InterfaceTypeDefinition(java.lang.String name)

alternative to using a Builder for convenience

Parameters:

name - of the interface

Method Detail

getImplements

public java.util.List<Type> getImplements()

Specified by:

getImplements in interface ImplementingTypeDefinition<InterfaceTypeDefinition>

getFieldDefinitions

public java.util.List<FieldDefinition> getFieldDefinitions()

Specified by:

getFieldDefinitions in interface ImplementingTypeDefinition<InterfaceTypeDefinition>

getDirectives

public java.util.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<InterfaceTypeDefinition>

Returns:

a list of all the directives associated with this Node

getName

public java.lang.String getName()

Specified by:

getName in interface NamedNode<InterfaceTypeDefinition>

Specified by:

getName in interface SDLNamedDefinition<InterfaceTypeDefinition>

Returns:

The name of this SDL definition

getChildren

public java.util.List<Node> getChildren()

Specified by:

getChildren in interface Node<InterfaceTypeDefinition>

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

Returns:

a container of the child nodes

withNewChildren

public InterfaceTypeDefinition withNewChildren(NodeChildrenContainer newChildren)

Description copied from interface: Node

Replaces the specified children and returns a new Node.

Specified by:

withNewChildren in interface Node<InterfaceTypeDefinition>

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

Parameters:

o - the other node to compare to

Returns:

isEqualTo

deepCopy

public InterfaceTypeDefinition deepCopy()

Specified by:

deepCopy in interface Node<InterfaceTypeDefinition>

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

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.

newInterfaceTypeDefinition

public static InterfaceTypeDefinition.Builder newInterfaceTypeDefinition()

transform

public InterfaceTypeDefinition transform(java.util.function.Consumer<InterfaceTypeDefinition.Builder> builderConsumer)