graphql.schema.GraphQLEnumValueDefinition Maven / Gradle / Ivy
package graphql.schema;
import graphql.DirectivesUtil;
import graphql.Internal;
import graphql.PublicApi;
import graphql.language.EnumValueDefinition;
import graphql.util.TraversalControl;
import graphql.util.TraverserContext;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import static graphql.Assert.assertNotNull;
import static graphql.Assert.assertValidName;
/**
* A graphql enumeration type has a limited set of values and this defines one of those unique values
*
* See https://graphql.org/learn/schema/#enumeration-types for more details
*
* @see graphql.schema.GraphQLEnumType
*/
@PublicApi
public class GraphQLEnumValueDefinition implements GraphQLNamedSchemaElement, GraphQLDirectiveContainer {
private final String name;
private final String description;
private final Object value;
private final String deprecationReason;
private final DirectivesUtil.DirectivesHolder directivesHolder;
private final EnumValueDefinition definition;
@Internal
private GraphQLEnumValueDefinition(String name,
String description,
Object value,
String deprecationReason,
List directives,
List appliedDirectives,
EnumValueDefinition definition) {
assertValidName(name);
assertNotNull(directives, () -> "directives cannot be null");
this.name = name;
this.description = description;
this.value = value;
this.deprecationReason = deprecationReason;
this.directivesHolder = DirectivesUtil.DirectivesHolder.create(directives, appliedDirectives);
this.definition = definition;
}
@Override
public String getName() {
return name;
}
public String getDescription() {
return description;
}
public Object getValue() {
return value;
}
public boolean isDeprecated() {
return deprecationReason != null;
}
public String getDeprecationReason() {
return deprecationReason;
}
@Override
public List getDirectives() {
return directivesHolder.getDirectives();
}
@Override
public Map getDirectivesByName() {
return directivesHolder.getDirectivesByName();
}
@Override
public Map> getAllDirectivesByName() {
return directivesHolder.getAllDirectivesByName();
}
@Override
public GraphQLDirective getDirective(String directiveName) {
return directivesHolder.getDirective(directiveName);
}
public EnumValueDefinition getDefinition() {
return definition;
}
@Override
public List getAppliedDirectives() {
return directivesHolder.getAppliedDirectives();
}
@Override
public Map> getAllAppliedDirectivesByName() {
return directivesHolder.getAllAppliedDirectivesByName();
}
@Override
public GraphQLAppliedDirective getAppliedDirective(String directiveName) {
return directivesHolder.getAppliedDirective(directiveName);
}
/**
* This helps you transform the current GraphQLEnumValueDefinition 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 field based on calling build on that builder
*/
public GraphQLEnumValueDefinition transform(Consumer builderConsumer) {
Builder builder = newEnumValueDefinition(this);
builderConsumer.accept(builder);
return builder.build();
}
@Override
public GraphQLSchemaElement copy() {
return newEnumValueDefinition(this).build();
}
@Override
public TraversalControl accept(TraverserContext context, GraphQLTypeVisitor visitor) {
return visitor.visitGraphQLEnumValueDefinition(this, context);
}
@Override
public List getChildren() {
List children = new ArrayList<>();
children.addAll(directivesHolder.getDirectives());
children.addAll(directivesHolder.getAppliedDirectives());
return children;
}
@Override
public SchemaElementChildrenContainer getChildrenWithTypeReferences() {
return SchemaElementChildrenContainer.newSchemaElementChildrenContainer()
.children(CHILD_DIRECTIVES, directivesHolder.getDirectives())
.children(CHILD_APPLIED_DIRECTIVES, directivesHolder.getAppliedDirectives())
.build();
}
@Override
public GraphQLEnumValueDefinition withNewChildren(SchemaElementChildrenContainer newChildren) {
return transform(builder -> builder
.replaceDirectives(newChildren.getChildren(CHILD_DIRECTIVES))
.replaceAppliedDirectives(newChildren.getChildren(CHILD_APPLIED_DIRECTIVES))
);
}
/**
* {@inheritDoc}
*/
@Override
public final boolean equals(Object o) {
return super.equals(o);
}
/**
* {@inheritDoc}
*/
@Override
public final int hashCode() {
return super.hashCode();
}
@Override
public String toString() {
return "GraphQLEnumValueDefinition{" +
"name='" + name + '\'' +
'}';
}
public static Builder newEnumValueDefinition() {
return new Builder();
}
public static Builder newEnumValueDefinition(GraphQLEnumValueDefinition existing) {
return new Builder(existing);
}
@PublicApi
public static class Builder extends GraphqlDirectivesContainerTypeBuilder {
private Object value;
private String deprecationReason;
private EnumValueDefinition definition;
public Builder() {
}
public Builder(GraphQLEnumValueDefinition existing) {
this.name = existing.getName();
this.description = existing.getDescription();
this.value = existing.getValue();
this.deprecationReason = existing.getDeprecationReason();
copyExistingDirectives(existing);
}
public Builder value(Object value) {
this.value = value;
return this;
}
public Builder deprecationReason(String deprecationReason) {
this.deprecationReason = deprecationReason;
return this;
}
public Builder definition(EnumValueDefinition definition) {
this.definition = definition;
return this;
}
// -- the following are repeated to avoid a binary incompatibility problem --
@Override
public Builder replaceDirectives(List directives) {
return super.replaceDirectives(directives);
}
@Override
public Builder withDirectives(GraphQLDirective... directives) {
return super.withDirectives(directives);
}
@Override
public Builder withDirective(GraphQLDirective directive) {
return super.withDirective(directive);
}
@Override
public Builder withDirective(GraphQLDirective.Builder builder) {
return super.withDirective(builder);
}
@Override
public Builder clearDirectives() {
return super.clearDirectives();
}
@Override
public Builder name(String name) {
return super.name(name);
}
@Override
public Builder description(String description) {
return super.description(description);
}
public GraphQLEnumValueDefinition build() {
return new GraphQLEnumValueDefinition(name,
description,
value,
deprecationReason,
sort(directives, GraphQLScalarType.class, GraphQLDirective.class),
sort(appliedDirectives, GraphQLScalarType.class, GraphQLAppliedDirective.class),
definition);
}
}
}