graphql.language

Class UnionTypeDefinition

java.lang.Object

graphql.language.AbstractNode<UnionTypeDefinition>

graphql.language.UnionTypeDefinition

All Implemented Interfaces:

Definition<UnionTypeDefinition>, DirectivesContainer<UnionTypeDefinition>, NamedNode<UnionTypeDefinition>, Node<UnionTypeDefinition>, SDLDefinition<UnionTypeDefinition>, TypeDefinition<UnionTypeDefinition>, java.io.Serializable

Direct Known Subclasses:

UnionTypeExtensionDefinition

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnionTypeDefinition.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
	UnionTypeDefinition(java.lang.String name) alternative to using a Builder for convenience
	UnionTypeDefinition(java.lang.String name, java.util.List<Directive> directives) alternative to using a Builder for convenience
protected	UnionTypeDefinition(java.lang.String name, java.util.List<Directive> directives, java.util.List<Type> memberTypes, Description description, SourceLocation sourceLocation, java.util.List<Comment> comments)

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<Node> context, NodeVisitor visitor) Double-dispatch entry point.
UnionTypeDefinition	deepCopy()
java.util.List<Node>	getChildren()
Description	getDescription()
java.util.List<Directive>	getDirectives()
java.util.List<Type>	getMemberTypes()
java.lang.String	getName()
boolean	isEqualTo(Node o) Compares just the content and not the children.
static UnionTypeDefinition.Builder	newUnionTypeDefinition()
java.lang.String	toString()
UnionTypeDefinition	transform(java.util.function.Consumer<UnionTypeDefinition.Builder> builderConsumer)

Methods inherited from class graphql.language.AbstractNode

deepCopy, deepCopy, getComments, 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

getComments, getSourceLocation

Methods inherited from interface graphql.language.DirectivesContainer

getDirective, getDirectivesByName

Constructor Detail

UnionTypeDefinition

protected UnionTypeDefinition(java.lang.String name,
                              java.util.List<Directive> directives,
                              java.util.List<Type> memberTypes,
                              Description description,
                              SourceLocation sourceLocation,
                              java.util.List<Comment> comments)

UnionTypeDefinition

public UnionTypeDefinition(java.lang.String name,
                           java.util.List<Directive> directives)

alternative to using a Builder for convenience

Parameters:

name - of the union

directives - on the union

UnionTypeDefinition

public UnionTypeDefinition(java.lang.String name)

alternative to using a Builder for convenience

Parameters:

name - of the union

Method Detail

getDirectives

public java.util.List<Directive> getDirectives()

Specified by:

getDirectives in interface DirectivesContainer<UnionTypeDefinition>

Specified by:

getDirectives in interface TypeDefinition<UnionTypeDefinition>

Returns:

the directives of this type being defined

getMemberTypes

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

getName

public java.lang.String getName()

Specified by:

getName in interface NamedNode<UnionTypeDefinition>

Specified by:

getName in interface TypeDefinition<UnionTypeDefinition>

Returns:

the name of the type being defined.

getDescription

public Description getDescription()

getChildren

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

Specified by:

getChildren in interface Node<UnionTypeDefinition>

Returns:

a list of the children of this 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 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<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(java.util.function.Consumer<UnionTypeDefinition.Builder> builderConsumer)