graphql.schema

Class GraphQLEnumValueDefinition

java.lang.Object

graphql.schema.GraphQLEnumValueDefinition

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLType

@PublicApi
public class GraphQLEnumValueDefinition
extends java.lang.Object
implements GraphQLDirectiveContainer

A graphql enumeration type has a limited set of values and this defines one of those unique values See http://graphql.org/learn/schema/#enumeration-types for more details

See Also:

GraphQLEnumType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLEnumValueDefinition.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLEnumValueDefinition(java.lang.String name, java.lang.String description, java.lang.Object value)
GraphQLEnumValueDefinition(java.lang.String name, java.lang.String description, java.lang.Object value, java.lang.String deprecationReason)
GraphQLEnumValueDefinition(java.lang.String name, java.lang.String description, java.lang.Object value, java.lang.String deprecationReason, java.util.List<GraphQLDirective> directives)

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
java.util.List<GraphQLType>	getChildren()
java.lang.String	getDeprecationReason()
java.lang.String	getDescription()
GraphQLDirective	getDirective(java.lang.String directiveName) Returns a named directive
java.util.List<GraphQLDirective>	getDirectives()
java.util.Map<java.lang.String,GraphQLDirective>	getDirectivesByName()
java.lang.String	getName()
java.lang.Object	getValue()
boolean	isDeprecated()
static GraphQLEnumValueDefinition.Builder	newEnumValueDefinition()
static GraphQLEnumValueDefinition.Builder	newEnumValueDefinition(GraphQLEnumValueDefinition existing)
GraphQLEnumValueDefinition	transform(java.util.function.Consumer<GraphQLEnumValueDefinition.Builder> builderConsumer) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphQLEnumValueDefinition

public GraphQLEnumValueDefinition(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.Object value)

GraphQLEnumValueDefinition

public GraphQLEnumValueDefinition(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.Object value,
                                  java.lang.String deprecationReason)

GraphQLEnumValueDefinition

public GraphQLEnumValueDefinition(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.Object value,
                                  java.lang.String deprecationReason,
                                  java.util.List<GraphQLDirective> directives)

Method Detail

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()

getValue

public java.lang.Object getValue()

isDeprecated

public boolean isDeprecated()

getDeprecationReason

public java.lang.String getDeprecationReason()

getDirectives

public java.util.List<GraphQLDirective> getDirectives()

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

getDirectivesByName

public java.util.Map<java.lang.String,GraphQLDirective> getDirectivesByName()

Specified by:

getDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a a map of directives by directive name

getDirective

public GraphQLDirective getDirective(java.lang.String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a named directive

Specified by:

getDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

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

transform

public GraphQLEnumValueDefinition transform(java.util.function.Consumer<GraphQLEnumValueDefinition.Builder> builderConsumer)

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.

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

newEnumValueDefinition

public static GraphQLEnumValueDefinition.Builder newEnumValueDefinition()

newEnumValueDefinition

public static GraphQLEnumValueDefinition.Builder newEnumValueDefinition(GraphQLEnumValueDefinition existing)