@PublicApi public class GraphQLUnionType extends java.lang.Object implements GraphQLNamedType, GraphQLOutputType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer
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.
Modifier and Type | Class and Description |
---|---|
static class |
GraphQLUnionType.Builder |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHILD_DIRECTIVES |
static java.lang.String |
CHILD_TYPES |
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. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDirective, getDirectivesByName
public static final java.lang.String CHILD_TYPES
public static final java.lang.String CHILD_DIRECTIVES
@Deprecated public GraphQLUnionType(java.lang.String name, java.lang.String description, java.util.List<GraphQLNamedOutputType> types, TypeResolver typeResolver)
newUnionType()
builder pattern instead, as this constructor will be made private in a future version.name
- the namedescription
- the descriptiontypes
- the possible typestypeResolver
- the type resolver function@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)
newUnionType()
builder pattern instead, as this constructor will be made private in a future version.name
- the namedescription
- the descriptiontypes
- the possible typestypeResolver
- the type resolver functiondirectives
- the directives on this type elementdefinition
- the AST definitionpublic java.util.List<GraphQLNamedOutputType> getTypes()
public java.lang.String getName()
getName
in interface GraphQLNamedSchemaElement
public java.lang.String getDescription()
public UnionTypeDefinition getDefinition()
public java.util.List<UnionTypeExtensionDefinition> getExtensionDefinitions()
public java.util.List<GraphQLDirective> getDirectives()
getDirectives
in interface GraphQLDirectiveContainer
public GraphQLUnionType transform(java.util.function.Consumer<GraphQLUnionType.Builder> builderConsumer)
builderConsumer
- the consumer code that will be given a builder to transformpublic TraversalControl accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
accept
in interface GraphQLSchemaElement
public java.util.List<GraphQLSchemaElement> getChildren()
getChildren
in interface GraphQLSchemaElement
public SchemaElementChildrenContainer getChildrenWithTypeReferences()
getChildrenWithTypeReferences
in interface GraphQLSchemaElement
public GraphQLUnionType withNewChildren(SchemaElementChildrenContainer newChildren)
withNewChildren
in interface GraphQLSchemaElement
public static GraphQLUnionType.Builder newUnionType()
public static GraphQLUnionType.Builder newUnionType(GraphQLUnionType existing)