graphql.schema

Class GraphQLEnumType

java.lang.Object

graphql.schema.GraphQLEnumType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputType, GraphQLNullableType, GraphQLOutputType, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLEnumType
extends java.lang.Object
implements GraphQLType, GraphQLInputType, GraphQLOutputType, 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

Constructor Summary

Constructors

Constructor and Description
GraphQLEnumType(java.lang.String name, java.lang.String description, java.util.List<GraphQLEnumValueDefinition> values)
GraphQLEnumType(java.lang.String name, java.lang.String description, java.util.List<GraphQLEnumValueDefinition> values, java.util.List<GraphQLDirective> directives, EnumTypeDefinition definition)

Method Summary

Modifier and Type	Method and Description
Coercing	getCoercing()
EnumTypeDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
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.

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

Constructor Detail

GraphQLEnumType

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

GraphQLEnumType

public GraphQLEnumType(java.lang.String name,
                       java.lang.String description,
                       java.util.List<GraphQLEnumValueDefinition> values,
                       java.util.List<GraphQLDirective> directives,
                       EnumTypeDefinition 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 GraphQLType

Returns:

the name of the type which MUST fit within the regular expression [_A-Za-z][_0-9A-Za-z]*

getDescription

public java.lang.String getDescription()

getCoercing

public Coercing getCoercing()

getDefinition

public EnumTypeDefinition getDefinition()

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

newEnum

public static GraphQLEnumType.Builder newEnum()

newEnum

public static GraphQLEnumType.Builder newEnum(GraphQLEnumType existing)