graphql.schema

Class GraphQLUnionType

java.lang.Object

graphql.schema.GraphQLUnionType

All Implemented Interfaces:

GraphQLCompositeType, GraphQLDirectiveContainer, GraphQLNamedOutputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLOutputType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLUnionType
extends java.lang.Object
implements GraphQLNamedOutputType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer

A union type is a polymorphic type that dynamically represents one of more concrete object types.

At runtime a TypeResolver is used to take an union object value and decide what GraphQLObjectType represents this union of types.

Note that members of a union type need to be concrete object types; you can't create a union type out of interfaces or other unions.

See http://graphql.org/learn/schema/#union-types for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLUnionType.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_DIRECTIVES
static java.lang.String	CHILD_TYPES

Constructor Summary

Constructors

Constructor and Description
GraphQLUnionType(java.lang.String name, java.lang.String description, java.util.List<GraphQLNamedOutputType> types, TypeResolver typeResolver) Deprecated. use the newUnionType() builder pattern instead, as this constructor will be made private in a future version.
GraphQLUnionType(java.lang.String name, java.lang.String description, java.util.List<GraphQLNamedOutputType> types, TypeResolver typeResolver, java.util.List<GraphQLDirective> directives, UnionTypeDefinition definition) Deprecated. use the newUnionType() builder pattern instead, as this constructor will be made private in a future version.

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
java.util.List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
UnionTypeDefinition	getDefinition() The AST Node this schema element is based on.
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.util.List<UnionTypeExtensionDefinition>	getExtensionDefinitions()
java.lang.String	getName()
java.util.List<GraphQLNamedOutputType>	getTypes()
static GraphQLUnionType.Builder	newUnionType()
static GraphQLUnionType.Builder	newUnionType(GraphQLUnionType existing)
GraphQLUnionType	transform(java.util.function.Consumer<GraphQLUnionType.Builder> builderConsumer) This helps you transform the current GraphQLUnionType into another one by starting a builder with all the current values and allows you to transform it how you want.
GraphQLUnionType	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirective, getDirectivesByName

Field Detail

CHILD_TYPES

public static final java.lang.String CHILD_TYPES

See Also:

Constant Field Values

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

Constructor Detail

GraphQLUnionType

@Deprecated
public GraphQLUnionType(java.lang.String name,
                                    java.lang.String description,
                                    java.util.List<GraphQLNamedOutputType> types,
                                    TypeResolver typeResolver)

Deprecated. use the newUnionType() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

types - the possible types

typeResolver - the type resolver function

GraphQLUnionType

@Deprecated
public GraphQLUnionType(java.lang.String name,
                                    java.lang.String description,
                                    java.util.List<GraphQLNamedOutputType> types,
                                    TypeResolver typeResolver,
                                    java.util.List<GraphQLDirective> directives,
                                    UnionTypeDefinition definition)

Deprecated. use the newUnionType() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

types - the possible types

typeResolver - the type resolver function

directives - the directives on this type element

definition - the AST definition

Method Detail

getTypes

public java.util.List<GraphQLNamedOutputType> getTypes()

Returns:

This returns GraphQLObjectType or GraphQLTypeReference instances, if the type references are not resolved yet. After they are resolved it contains only GraphQLObjectType. Reference resolving happens when a full schema is built.

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

getDefinition

public UnionTypeDefinition getDefinition()

Description copied from interface: GraphQLNamedSchemaElement

The AST Node this schema element is based on. Is null if the GraphQLSchema is not based on a SDL document. Some elements also have additional extension Nodes. See for example GraphQLObjectType.getExtensionDefinitions()

Specified by:

getDefinition in interface GraphQLNamedSchemaElement

Returns:

Node which this element is based on. Can be null.

getExtensionDefinitions

public java.util.List<UnionTypeExtensionDefinition> getExtensionDefinitions()

getDirectives

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

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

transform

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

This helps you transform the current GraphQLUnionType into another one by starting a builder with all the current values and allows you to transform it how you want.

Parameters:

builderConsumer - the consumer code that will be given a builder to transform

Returns:

a new object based on calling build on that builder

accept

public TraversalControl accept(TraverserContext<GraphQLSchemaElement> context,
                               GraphQLTypeVisitor visitor)

Specified by:

accept in interface GraphQLSchemaElement

getChildren

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

Specified by:

getChildren in interface GraphQLSchemaElement

getChildrenWithTypeReferences

public SchemaElementChildrenContainer getChildrenWithTypeReferences()

Specified by:

getChildrenWithTypeReferences in interface GraphQLSchemaElement

withNewChildren

public GraphQLUnionType withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

newUnionType

public static GraphQLUnionType.Builder newUnionType()

newUnionType

public static GraphQLUnionType.Builder newUnionType(GraphQLUnionType existing)