graphql.schema

Class GraphQLUnionType

java.lang.Object

graphql.schema.GraphQLUnionType

All Implemented Interfaces:

GraphQLCompositeType, GraphQLDirectiveContainer, GraphQLNullableType, GraphQLOutputType, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLUnionType
extends java.lang.Object
implements GraphQLType, GraphQLOutputType, 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

Constructor Summary

Constructors

Constructor and Description
GraphQLUnionType(java.lang.String name, java.lang.String description, java.util.List<GraphQLOutputType> types, TypeResolver typeResolver)
GraphQLUnionType(java.lang.String name, java.lang.String description, java.util.List<GraphQLOutputType> types, TypeResolver typeResolver, java.util.List<GraphQLDirective> directives, UnionTypeDefinition definition)

Method Summary

Modifier and Type	Method and Description
UnionTypeDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.lang.String	getName()
TypeResolver	getTypeResolver()
java.util.List<GraphQLOutputType>	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.

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

Constructor Detail

GraphQLUnionType

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

GraphQLUnionType

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

Method Detail

getTypes

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

getTypeResolver

public TypeResolver getTypeResolver()

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLType

Returns:

the name of the type which MUST fit within the regular expression [_A-Za-z][_0-9A-Za-z]*

getDescription

public java.lang.String getDescription()

getDefinition

public UnionTypeDefinition getDefinition()

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

newUnionType

public static GraphQLUnionType.Builder newUnionType()

newUnionType

public static GraphQLUnionType.Builder newUnionType(GraphQLUnionType existing)