Package graphql.language

Class UnionTypeDefinition

java.lang.Object

graphql.language.AbstractNode<UnionTypeDefinition>

graphql.language.AbstractDescribedNode<UnionTypeDefinition>

graphql.language.UnionTypeDefinition

All Implemented Interfaces:

Definition<UnionTypeDefinition>, DescribedNode<UnionTypeDefinition>, DirectivesContainer<UnionTypeDefinition>, NamedNode<UnionTypeDefinition>, Node<UnionTypeDefinition>, SDLDefinition<UnionTypeDefinition>, SDLNamedDefinition<UnionTypeDefinition>, TypeDefinition<UnionTypeDefinition>, Serializable

Direct Known Subclasses:

UnionTypeExtensionDefinition

@PublicApi
public class UnionTypeDefinition
extends AbstractDescribedNode<UnionTypeDefinition>
implements TypeDefinition<UnionTypeDefinition>, DirectivesContainer<UnionTypeDefinition>, NamedNode<UnionTypeDefinition>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UnionTypeDefinition.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILD_DIRECTIVES
static final String	CHILD_MEMBER_TYPES

Fields inherited from class graphql.language.AbstractDescribedNode

description

Constructor Summary

Constructors

Modifier	Constructor	Description
	UnionTypeDefinition(String name)	alternative to using a Builder for convenience
	UnionTypeDefinition(String name, List<Directive> directives)	alternative to using a Builder for convenience
protected	UnionTypeDefinition(String name, List<Directive> directives, List<Type> memberTypes, Description description, 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.
UnionTypeDefinition	deepCopy()
List<Node>	getChildren()
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.
List<Directive>	getDirectives(String directiveName)	Returns all the directives with the provided name, including repeatable and non repeatable directives.
Map<String,List<Directive>>	getDirectivesByName()	This will return a Map of the all directives that are associated with a Node, including both repeatable and non repeatable directives.
List<Type>	getMemberTypes()
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	hasDirective(String directiveName)	This returns true if the AST node contains one or more directives by the specified name
boolean	isEqualTo(Node o)	Compares just the content and not the children.
static UnionTypeDefinition.Builder	newUnionTypeDefinition()
String	toString()
UnionTypeDefinition	transform(Consumer<UnionTypeDefinition.Builder> builderConsumer)
UnionTypeDefinition	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_DIRECTIVES

public static final String CHILD_DIRECTIVES

See Also:

• Constant Field Values

CHILD_MEMBER_TYPES

public static final String CHILD_MEMBER_TYPES

See Also:

• Constant Field Values

Constructor Details

UnionTypeDefinition

protected UnionTypeDefinition(String name,
 List<Directive> directives,
 List<Type> memberTypes,
 Description description,
 SourceLocation sourceLocation,
 List<Comment> comments,
 IgnoredChars ignoredChars,
 Map<String,String> additionalData)

UnionTypeDefinition

public UnionTypeDefinition(String name,
 List<Directive> directives)

alternative to using a Builder for convenience

Parameters:

name - of the union

directives - on the union

UnionTypeDefinition

public UnionTypeDefinition(String name)

alternative to using a Builder for convenience

Parameters:

name - of the union

Method Details

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

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

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

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

Parameters:

directiveName - the name ot check

Returns:

true if the AST node contains one or more directives by the specified name

getMemberTypes

public List<Type> getMemberTypes()

getName

public String getName()

Specified by:

getName in interface NamedNode<UnionTypeDefinition>

Specified by:

getName in interface SDLNamedDefinition<UnionTypeDefinition>

Returns:

The name of this SDL definition

getChildren

public List<Node> getChildren()

Specified by:

getChildren in interface Node<UnionTypeDefinition>

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

Returns:

a container of the child nodes

withNewChildren

public UnionTypeDefinition withNewChildren(NodeChildrenContainer newChildren)

Description copied from interface: Node

Replaces the specified children and returns a new Node.

Specified by:

withNewChildren in interface Node<UnionTypeDefinition>

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

Parameters:

o - the other node to compare to

Returns:

isEqualTo

deepCopy

public UnionTypeDefinition deepCopy()

Specified by:

deepCopy in interface Node<UnionTypeDefinition>

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

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.

newUnionTypeDefinition

public static UnionTypeDefinition.Builder newUnionTypeDefinition()

transform

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