Package graphql.schema

Class GraphQLEnumType

java.lang.Object

graphql.schema.GraphQLEnumType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputSchemaElement, GraphQLInputType, GraphQLNamedInputType, GraphQLNamedOutputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLOutputType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLEnumType
extends Object
implements GraphQLNamedInputType, GraphQLNamedOutputType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLDirectiveContainer

A graphql enumeration type has a limited set of values.

This allows you to validate that any arguments of this type are one of the allowed values and communicate through the type system that a field will always be one of a finite set of values.

See https://graphql.org/learn/schema/#enumeration-types for more details

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphQLEnumType.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILD_VALUES

Fields inherited from interface graphql.schema.GraphQLDirectiveContainer

CHILD_APPLIED_DIRECTIVES, CHILD_DIRECTIVES

Method Summary

Modifier and Type	Method	Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
GraphQLSchemaElement	copy()	Each GraphQLSchemaElement should make a copy of itself when this is called.
final boolean	equals(Object o)	No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
Map<String,List<GraphQLAppliedDirective>>	getAllAppliedDirectivesByName()	This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.
Map<String,List<GraphQLDirective>>	getAllDirectivesByName()	This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.
GraphQLAppliedDirective	getAppliedDirective(String directiveName)	Returns a non-repeatable directive with the provided name.
List<GraphQLAppliedDirective>	getAppliedDirectives()	This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.
List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
EnumTypeDefinition	getDefinition()	The AST Node this schema element is based on.
String	getDescription()
GraphQLDirective	getDirective(String directiveName)	Returns a non-repeatable directive with the provided name.
List<GraphQLDirective>	getDirectives()	This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.
Map<String,GraphQLDirective>	getDirectivesByName()	This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement.
List<EnumTypeExtensionDefinition>	getExtensionDefinitions()
String	getName()
GraphQLEnumValueDefinition	getValue(String name)
List<GraphQLEnumValueDefinition>	getValues()
final int	hashCode()	No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
static GraphQLEnumType.Builder	newEnum()
static GraphQLEnumType.Builder	newEnum(GraphQLEnumType existing)
Object	parseLiteral(Value<?> input, GraphQLContext graphQLContext, Locale locale)
Object	parseLiteral(Object input)	Deprecated.
Object	parseValue(Object input)	Deprecated.
Object	parseValue(Object input, GraphQLContext graphQLContext, Locale locale)
Object	serialize(Object input)	Deprecated.
Object	serialize(Object input, GraphQLContext graphQLContext, Locale locale)
String	toString()
GraphQLEnumType	transform(Consumer<GraphQLEnumType.Builder> builderConsumer)	This helps you transform the current GraphQLEnumType into another one by starting a builder with all the current values and allows you to transform it how you want.
Value	valueToLiteral(Object input)	Deprecated.
Value<?>	valueToLiteral(Object input, GraphQLContext graphQLContext, Locale locale)
GraphQLEnumType	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getAppliedDirectives, getDirectives, hasAppliedDirective, hasDirective

Field Details

CHILD_VALUES

public static final String CHILD_VALUES

See Also:

• Constant Field Values

Method Details

serialize

@Deprecated
public Object serialize(Object input)

Deprecated.

serialize

public Object serialize(Object input,
 GraphQLContext graphQLContext,
 Locale locale)

parseValue

@Deprecated
public Object parseValue(Object input)

Deprecated.

parseValue

public Object parseValue(Object input,
 GraphQLContext graphQLContext,
 Locale locale)

parseLiteral

@Deprecated
public Object parseLiteral(Object input)

Deprecated.

parseLiteral

public Object parseLiteral(Value<?> input,
 GraphQLContext graphQLContext,
 Locale locale)

valueToLiteral

@Deprecated
public Value valueToLiteral(Object input)

Deprecated.

valueToLiteral

public Value<?> valueToLiteral(Object input,
 GraphQLContext graphQLContext,
 Locale locale)

getValues

public List<GraphQLEnumValueDefinition> getValues()

getValue

public GraphQLEnumValueDefinition getValue(String name)

getName

public String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

Returns:

the name of this element. This cant be null

getDescription

public String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

Returns:

the description of this element. This can be null

getDefinition

public EnumTypeDefinition 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 List<EnumTypeExtensionDefinition> getExtensionDefinitions()

getDirectives

public List<GraphQLDirective> getDirectives()

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getDirectivesByName

public Map<String,GraphQLDirective> getDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement. Any repeatable directives will be filtered out of this map.

Specified by:

getDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of non repeatable directives by directive name.

getAllDirectivesByName

public Map<String,List<GraphQLDirective>> getAllDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.

Specified by:

getAllDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getDirective

public GraphQLDirective getDirective(String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non-repeatable directive with the provided name. This will throw a AssertException if the directive is a repeatable directive that has more then one instance.

Specified by:

getDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

the directive or null if there is not one with that name

getAppliedDirectives

public List<GraphQLAppliedDirective> getAppliedDirectives()

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.

Specified by:

getAppliedDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getAllAppliedDirectivesByName

public Map<String,List<GraphQLAppliedDirective>> getAllAppliedDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.

Specified by:

getAllAppliedDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getAppliedDirective

public GraphQLAppliedDirective getAppliedDirective(String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non-repeatable directive with the provided name.

Specified by:

getAppliedDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

the directive or null if there is not one with that name

transform

public GraphQLEnumType transform(Consumer<GraphQLEnumType.Builder> builderConsumer)

This helps you transform the current GraphQLEnumType 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 field based on calling build on that builder

copy

public GraphQLSchemaElement copy()

Description copied from interface: GraphQLSchemaElement

Each GraphQLSchemaElement should make a copy of itself when this is called. The copy should be included its current contents as they currently exist into a new object.

Specified by:

copy in interface GraphQLSchemaElement

Returns:

a copy of this element

accept

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

Specified by:

accept in interface GraphQLSchemaElement

getChildren

public List<GraphQLSchemaElement> getChildren()

Specified by:

getChildren in interface GraphQLSchemaElement

getChildrenWithTypeReferences

public SchemaElementChildrenContainer getChildrenWithTypeReferences()

Specified by:

getChildrenWithTypeReferences in interface GraphQLSchemaElement

withNewChildren

public GraphQLEnumType withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

equals

public final boolean equals(Object o)

No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

equals in interface GraphQLSchemaElement

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public final int hashCode()

No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

hashCode in interface GraphQLSchemaElement

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

toString

public String toString()

Overrides:

toString in class Object

newEnum

public static GraphQLEnumType.Builder newEnum()

newEnum

public static GraphQLEnumType.Builder newEnum(GraphQLEnumType existing)