graphql.schema

Class GraphQLEnumType

java.lang.Object

graphql.schema.GraphQLEnumType

All Implemented Interfaces:

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

@PublicApi
public class GraphQLEnumType
extends java.lang.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 http://graphql.org/learn/schema/#enumeration-types for more details

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLEnumType.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_DIRECTIVES
static java.lang.String	CHILD_VALUES

Constructor Summary

Constructors

Constructor and Description
GraphQLEnumType(java.lang.String name, java.lang.String description, java.util.List<GraphQLEnumValueDefinition> values) Deprecated. use the newEnum() builder pattern instead, as this constructor will be made private in a future version.
GraphQLEnumType(java.lang.String name, java.lang.String description, java.util.List<GraphQLEnumValueDefinition> values, java.util.List<GraphQLDirective> directives, EnumTypeDefinition definition) Deprecated. use the newEnum() builder pattern instead, as this constructor will be made private in a future version.

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
java.util.List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
Coercing	getCoercing()
EnumTypeDefinition	getDefinition() The AST Node this schema element is based on.
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.util.List<EnumTypeExtensionDefinition>	getExtensionDefinitions()
java.lang.String	getName()
GraphQLEnumValueDefinition	getValue(java.lang.String name)
java.util.List<GraphQLEnumValueDefinition>	getValues()
static GraphQLEnumType.Builder	newEnum()
static GraphQLEnumType.Builder	newEnum(GraphQLEnumType existing)
GraphQLEnumType	transform(java.util.function.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.
GraphQLEnumType	withNewChildren(SchemaElementChildrenContainer newChildren)

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

Field Detail

CHILD_VALUES

public static final java.lang.String CHILD_VALUES

See Also:

Constant Field Values

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

Constructor Detail

GraphQLEnumType

@Deprecated
public GraphQLEnumType(java.lang.String name,
                                   java.lang.String description,
                                   java.util.List<GraphQLEnumValueDefinition> values)

Deprecated. use the newEnum() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

values - the values

GraphQLEnumType

@Deprecated
public GraphQLEnumType(java.lang.String name,
                                   java.lang.String description,
                                   java.util.List<GraphQLEnumValueDefinition> values,
                                   java.util.List<GraphQLDirective> directives,
                                   EnumTypeDefinition definition)

Deprecated. use the newEnum() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

values - the values

directives - the directives on this type element

definition - the AST definition

Method Detail

getValues

public java.util.List<GraphQLEnumValueDefinition> getValues()

getValue

public GraphQLEnumValueDefinition getValue(java.lang.String name)

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

getCoercing

public Coercing getCoercing()

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 java.util.List<EnumTypeExtensionDefinition> getExtensionDefinitions()

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 GraphQLEnumType transform(java.util.function.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

accept

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

Specified by:

accept in interface GraphQLSchemaElement

getChildren

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

newEnum

public static GraphQLEnumType.Builder newEnum()

newEnum

public static GraphQLEnumType.Builder newEnum(GraphQLEnumType existing)