graphql.schema

Class GraphQLFieldDefinition

java.lang.Object

graphql.schema.GraphQLFieldDefinition

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLNamedSchemaElement, GraphQLSchemaElement

@PublicApi
public class GraphQLFieldDefinition
extends java.lang.Object
implements GraphQLNamedSchemaElement, GraphQLDirectiveContainer

Fields are the ways you get data values in graphql and a field definition represents a field, its type, the arguments it takes and the DataFetcher used to get data values for that field. Fields can be thought of as functions in graphql, they have a name, take defined arguments and return a value. Fields can also be deprecated, which indicates the consumers that a field wont be supported in the future. See http://graphql.org/learn/queries/#fields for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLFieldDefinition.Builder

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GraphQLFieldDefinition(java.lang.String name, java.lang.String description, GraphQLOutputType type, DataFetcher<?> dataFetcher, java.util.List<GraphQLArgument> arguments, java.lang.String deprecationReason) Deprecated. use the newFieldDefinition() builder pattern instead, as this constructor will be made private in a future version.
GraphQLFieldDefinition(java.lang.String name, java.lang.String description, GraphQLOutputType type, DataFetcherFactory dataFetcherFactory, java.util.List<GraphQLArgument> arguments, java.lang.String deprecationReason, java.util.List<GraphQLDirective> directives, FieldDefinition definition) Deprecated. use the newFieldDefinition() 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)
GraphQLArgument	getArgument(java.lang.String name)
java.util.List<GraphQLArgument>	getArguments()
java.util.List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
FieldDefinition	getDefinition() The AST Node this schema element is based on.
java.lang.String	getDeprecationReason()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.lang.String	getName()
GraphQLOutputType	getType()
boolean	isDeprecated()
static GraphQLFieldDefinition.Builder	newFieldDefinition()
static GraphQLFieldDefinition.Builder	newFieldDefinition(GraphQLFieldDefinition existing)
java.lang.String	toString()
GraphQLFieldDefinition	transform(java.util.function.Consumer<GraphQLFieldDefinition.Builder> builderConsumer) This helps you transform the current GraphQLFieldDefinition into another one by starting a builder with all the current values and allows you to transform it how you want.
GraphQLSchemaElement	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirective, getDirectivesByName

Field Detail

CHILD_ARGUMENTS

public static final java.lang.String CHILD_ARGUMENTS

See Also:

Constant Field Values

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

CHILD_TYPE

public static final java.lang.String CHILD_TYPE

See Also:

Constant Field Values

Constructor Detail

GraphQLFieldDefinition

@Deprecated
public GraphQLFieldDefinition(java.lang.String name,
                                          java.lang.String description,
                                          GraphQLOutputType type,
                                          DataFetcher<?> dataFetcher,
                                          java.util.List<GraphQLArgument> arguments,
                                          java.lang.String deprecationReason)

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

Parameters:

name - the name

description - the description

type - the field type

dataFetcher - the field data fetcher

arguments - the field arguments

deprecationReason - the deprecation reason

GraphQLFieldDefinition

@Deprecated
public GraphQLFieldDefinition(java.lang.String name,
                                          java.lang.String description,
                                          GraphQLOutputType type,
                                          DataFetcherFactory dataFetcherFactory,
                                          java.util.List<GraphQLArgument> arguments,
                                          java.lang.String deprecationReason,
                                          java.util.List<GraphQLDirective> directives,
                                          FieldDefinition definition)

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

Parameters:

name - the name

description - the description

type - the field type

dataFetcherFactory - the field data fetcher factory

arguments - the field arguments

deprecationReason - the deprecation reason

directives - the directives on this type element

definition - the AST definition

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

getType

public GraphQLOutputType getType()

getArgument

public GraphQLArgument getArgument(java.lang.String name)

getDirectives

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

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

getArguments

public java.util.List<GraphQLArgument> getArguments()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

getDefinition

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

getDeprecationReason

public java.lang.String getDeprecationReason()

isDeprecated

public boolean isDeprecated()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transform

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

This helps you transform the current GraphQLFieldDefinition 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 GraphQLSchemaElement withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

newFieldDefinition

public static GraphQLFieldDefinition.Builder newFieldDefinition(GraphQLFieldDefinition existing)

newFieldDefinition

public static GraphQLFieldDefinition.Builder newFieldDefinition()