graphql.schema.GraphQLUnionType Maven / Gradle / Ivy
package graphql.schema;
import graphql.Internal;
import graphql.PublicApi;
import graphql.language.UnionTypeDefinition;
import graphql.util.TraversalControl;
import graphql.util.TraverserContext;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import static graphql.Assert.assertNotEmpty;
import static graphql.Assert.assertNotNull;
import static graphql.Assert.assertValidName;
import static graphql.schema.SchemaElementChildrenContainer.newSchemaElementChildrenContainer;
import static graphql.util.FpKit.getByName;
import static java.util.Collections.emptyList;
import static java.util.Collections.unmodifiableList;
/**
* A union type is a polymorphic type that dynamically represents one of more concrete object types.
*
* At runtime a {@link graphql.schema.TypeResolver} is used to take an union object value and decide what {@link graphql.schema.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.
*/
@PublicApi
public class GraphQLUnionType implements GraphQLNamedType, GraphQLOutputType, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer {
private final String name;
private final String description;
private final List originalTypes;
private final TypeResolver typeResolver;
private final UnionTypeDefinition definition;
private final List directives;
private List replacedTypes;
public static final String CHILD_TYPES = "types";
public static final String CHILD_DIRECTIVES = "directives";
/**
* @param name the name
* @param description the description
* @param types the possible types
* @param typeResolver the type resolver function
*
* @deprecated use the {@link #newUnionType()} builder pattern instead, as this constructor will be made private in a future version.
*/
@Internal
@Deprecated
public GraphQLUnionType(String name, String description, List types, TypeResolver typeResolver) {
this(name, description, types, typeResolver, emptyList(), null);
}
/**
* @param name the name
* @param description the description
* @param types the possible types
* @param typeResolver the type resolver function
* @param directives the directives on this type element
* @param definition the AST definition
*
* @deprecated use the {@link #newUnionType()} builder pattern instead, as this constructor will be made private in a future version.
*/
@Internal
@Deprecated
public GraphQLUnionType(String name, String description, List types, TypeResolver typeResolver, List directives, UnionTypeDefinition definition) {
assertValidName(name);
assertNotNull(types, "types can't be null");
assertNotEmpty(types, "A Union type must define one or more member types.");
assertNotNull(directives, "directives cannot be null");
this.name = name;
this.description = description;
this.originalTypes = types;
this.typeResolver = typeResolver;
this.definition = definition;
this.directives = directives;
}
void replaceTypes(List types) {
this.replacedTypes = types;
}
/**
* @return 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.
*/
public List getTypes() {
if (replacedTypes != null) {
return Collections.unmodifiableList(replacedTypes);
}
return unmodifiableList(originalTypes);
}
// to be removed in a future version when all code is in the code registry
TypeResolver getTypeResolver() {
return typeResolver;
}
@Override
public String getName() {
return name;
}
public String getDescription() {
return description;
}
public UnionTypeDefinition getDefinition() {
return definition;
}
@Override
public List getDirectives() {
return new ArrayList<>(directives);
}
/**
* 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.
*
* @param builderConsumer the consumer code that will be given a builder to transform
*
* @return a new object based on calling build on that builder
*/
public GraphQLUnionType transform(Consumer builderConsumer) {
Builder builder = newUnionType(this);
builderConsumer.accept(builder);
return builder.build();
}
@Override
public TraversalControl accept(TraverserContext context, GraphQLTypeVisitor visitor) {
return visitor.visitGraphQLUnionType(this, context);
}
@Override
public List getChildren() {
List children = new ArrayList<>(getTypes());
children.addAll(directives);
return children;
}
@Override
public SchemaElementChildrenContainer getChildrenWithTypeReferences() {
return newSchemaElementChildrenContainer()
.children(CHILD_TYPES, originalTypes)
.children(CHILD_DIRECTIVES, directives)
.build();
}
@Override
public GraphQLUnionType withNewChildren(SchemaElementChildrenContainer newChildren) {
return transform(builder ->
builder.replaceDirectives(newChildren.getChildren(CHILD_DIRECTIVES))
.replacePossibleTypes(newChildren.getChildren(CHILD_TYPES))
);
}
public static Builder newUnionType() {
return new Builder();
}
public static Builder newUnionType(GraphQLUnionType existing) {
return new Builder(existing);
}
@PublicApi
public static class Builder extends GraphqlTypeBuilder {
private TypeResolver typeResolver;
private UnionTypeDefinition definition;
private final Map types = new LinkedHashMap<>();
private final Map directives = new LinkedHashMap<>();
public Builder() {
}
public Builder(GraphQLUnionType existing) {
this.name = existing.getName();
this.description = existing.getDescription();
this.typeResolver = existing.getTypeResolver();
this.definition = existing.getDefinition();
this.types.putAll(getByName(existing.originalTypes, GraphQLNamedType::getName));
this.directives.putAll(getByName(existing.getDirectives(), GraphQLDirective::getName));
}
@Override
public Builder name(String name) {
super.name(name);
return this;
}
@Override
public Builder description(String description) {
super.description(description);
return this;
}
@Override
public Builder comparatorRegistry(GraphqlTypeComparatorRegistry comparatorRegistry) {
super.comparatorRegistry(comparatorRegistry);
return this;
}
public Builder definition(UnionTypeDefinition definition) {
this.definition = definition;
return this;
}
@Deprecated
public Builder typeResolver(TypeResolver typeResolver) {
this.typeResolver = typeResolver;
return this;
}
public Builder possibleType(GraphQLObjectType type) {
assertNotNull(type, "possible type can't be null");
types.put(type.getName(), type);
return this;
}
public Builder possibleType(GraphQLTypeReference reference) {
assertNotNull(reference, "reference can't be null");
types.put(reference.getName(), reference);
return this;
}
public Builder possibleTypes(GraphQLObjectType... type) {
for (GraphQLObjectType graphQLType : type) {
possibleType(graphQLType);
}
return this;
}
public Builder replacePossibleTypes(List types) {
this.types.clear();
for (GraphQLObjectType graphQLType : types) {
possibleType(graphQLType);
}
return this;
}
public Builder possibleTypes(GraphQLTypeReference... references) {
for (GraphQLTypeReference reference : references) {
possibleType(reference);
}
return this;
}
/**
* This is used to clear all the types in the builder so far.
*
* @return the builder
*/
public Builder clearPossibleTypes() {
types.clear();
return this;
}
public boolean containType(String name) {
return types.containsKey(name);
}
public Builder withDirectives(GraphQLDirective... directives) {
for (GraphQLDirective directive : directives) {
withDirective(directive);
}
return this;
}
public Builder replaceDirectives(List directives) {
assertNotNull(directives, "directive can't be null");
this.directives.clear();
for (GraphQLDirective directive : directives) {
this.directives.put(directive.getName(), directive);
}
return this;
}
public Builder withDirective(GraphQLDirective directive) {
assertNotNull(directive, "directive can't be null");
directives.put(directive.getName(), directive);
return this;
}
public Builder withDirective(GraphQLDirective.Builder builder) {
return withDirective(builder.build());
}
/**
* This is used to clear all the directives in the builder so far.
*
* @return the builder
*/
public Builder clearDirectives() {
directives.clear();
return this;
}
public GraphQLUnionType build() {
return new GraphQLUnionType(
name,
description,
sort(types, GraphQLUnionType.class, GraphQLOutputType.class),
typeResolver,
sort(directives, GraphQLUnionType.class, GraphQLDirective.class),
definition);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy