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) 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<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
java.util.List<GraphQLType>	getChildren()
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

@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 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

accept

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

Description copied from interface: GraphQLType

Double-dispatch entry point. It allows to travers a given non-trivial graphQL type and move from root to nested or enclosed types. This implements similar pattern as Node, see accept(...) for more details about the pattern.

Specified by:

accept in interface GraphQLType

Parameters:

context - TraverserContext bound to this graphQL type object

visitor - Visitor instance that performs actual processing on the types(s)

Returns:

Result of Visitor's operation. Note! Visitor's operation might return special results to control traversal process.

getChildren

public java.util.List<GraphQLType> getChildren()

Specified by:

getChildren in interface GraphQLType

Returns:

returns all types directly associated with this node

newEnum

public static GraphQLEnumType.Builder newEnum()

newEnum

public static GraphQLEnumType.Builder newEnum(GraphQLEnumType existing)