graphql.schema

Class GraphQLEnumValueDefinition

java.lang.Object

graphql.schema.GraphQLEnumValueDefinition

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLNamedSchemaElement, GraphQLSchemaElement

@PublicApi
public class GraphQLEnumValueDefinition
extends java.lang.Object
implements GraphQLNamedSchemaElement, 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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GraphQLEnumValueDefinition(java.lang.String name, java.lang.String description, java.lang.Object value) Deprecated. use the newEnumValueDefinition() builder pattern instead, as this constructor will be made private in a future version.
GraphQLEnumValueDefinition(java.lang.String name, java.lang.String description, java.lang.Object value, java.lang.String deprecationReason) Deprecated. use the newEnumValueDefinition() builder pattern instead, as this constructor will be made private in a future version.
GraphQLEnumValueDefinition(java.lang.String name, java.lang.String description, java.lang.Object value, java.lang.String deprecationReason, java.util.List<GraphQLDirective> directives) Deprecated. use the newEnumValueDefinition() 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()
EnumValueDefinition	getDefinition() The AST Node this schema element is based on.
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.
GraphQLEnumValueDefinition	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

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

Field Detail

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

Constructor Detail

GraphQLEnumValueDefinition

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

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

Parameters:

name - the name

description - the description

value - the value

GraphQLEnumValueDefinition

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

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

Parameters:

name - the name

description - the description

value - the value

deprecationReason - the deprecation reasons

GraphQLEnumValueDefinition

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

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

Parameters:

name - the name

description - the description

value - the value

deprecationReason - the deprecation reasons

directives - the directives on this type element

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

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

getDefinition

public EnumValueDefinition 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.

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<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 GraphQLEnumValueDefinition withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

newEnumValueDefinition

public static GraphQLEnumValueDefinition.Builder newEnumValueDefinition()

newEnumValueDefinition

public static GraphQLEnumValueDefinition.Builder newEnumValueDefinition(GraphQLEnumValueDefinition existing)