Package graphql.schema

Class GraphQLFieldDefinition

java.lang.Object

graphql.schema.GraphQLFieldDefinition

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLNamedSchemaElement, GraphQLSchemaElement

@PublicApi
public class GraphQLFieldDefinition
extends 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 https://graphql.org/learn/queries/#fields for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphQLFieldDefinition.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILD_ARGUMENTS
static final String	CHILD_TYPE

Fields inherited from interface graphql.schema.GraphQLDirectiveContainer

CHILD_APPLIED_DIRECTIVES, CHILD_DIRECTIVES

Method Summary

Modifier and Type	Method	Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
GraphQLSchemaElement	copy()	Each GraphQLSchemaElement should make a copy of itself when this is called.
final boolean	equals(Object o)	No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
Map<String,List<GraphQLAppliedDirective>>	getAllAppliedDirectivesByName()	This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.
Map<String,List<GraphQLDirective>>	getAllDirectivesByName()	This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.
GraphQLAppliedDirective	getAppliedDirective(String directiveName)	Returns a non-repeatable directive with the provided name.
List<GraphQLAppliedDirective>	getAppliedDirectives()	This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.
GraphQLArgument	getArgument(String name)
List<GraphQLArgument>	getArguments()
List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
FieldDefinition	getDefinition()	The AST Node this schema element is based on.
String	getDeprecationReason()
String	getDescription()
GraphQLDirective	getDirective(String directiveName)	Returns a non-repeatable directive with the provided name.
List<GraphQLDirective>	getDirectives()	This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.
Map<String,GraphQLDirective>	getDirectivesByName()	This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement.
String	getName()
GraphQLOutputType	getType()
final int	hashCode()	No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
boolean	isDeprecated()
static GraphQLFieldDefinition.Builder	newFieldDefinition()
static GraphQLFieldDefinition.Builder	newFieldDefinition(GraphQLFieldDefinition existing)
String	toString()
GraphQLFieldDefinition	transform(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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getAppliedDirectives, getDirectives, hasAppliedDirective, hasDirective

Field Details

CHILD_ARGUMENTS

public static final String CHILD_ARGUMENTS

See Also:

• Constant Field Values

CHILD_TYPE

public static final String CHILD_TYPE

See Also:

• Constant Field Values

Method Details

getName

public String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

Returns:

the name of this element. This cant be null

getType

public GraphQLOutputType getType()

getArgument

public GraphQLArgument getArgument(String name)

getDirectives

public List<GraphQLDirective> getDirectives()

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getDirectivesByName

public Map<String,GraphQLDirective> getDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement. Any repeatable directives will be filtered out of this map.

Specified by:

getDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of non repeatable directives by directive name.

getAllDirectivesByName

public Map<String,List<GraphQLDirective>> getAllDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.

Specified by:

getAllDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getDirective

public GraphQLDirective getDirective(String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non-repeatable directive with the provided name. This will throw a AssertException if the directive is a repeatable directive that has more then one instance.

Specified by:

getDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

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

getAppliedDirectives

public List<GraphQLAppliedDirective> getAppliedDirectives()

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.

Specified by:

getAppliedDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getAllAppliedDirectivesByName

public Map<String,List<GraphQLAppliedDirective>> getAllAppliedDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.

Specified by:

getAllAppliedDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getAppliedDirective

public GraphQLAppliedDirective getAppliedDirective(String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non-repeatable directive with the provided name.

Specified by:

getAppliedDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

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

getArguments

public List<GraphQLArgument> getArguments()

getDescription

public String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

Returns:

the description of this element. This can be null

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

isDeprecated

public boolean isDeprecated()

toString

public String toString()

Overrides:

toString in class Object

transform

public GraphQLFieldDefinition transform(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

copy

public GraphQLSchemaElement copy()

Description copied from interface: GraphQLSchemaElement

Each GraphQLSchemaElement should make a copy of itself when this is called. The copy should be included its current contents as they currently exist into a new object.

Specified by:

copy in interface GraphQLSchemaElement

Returns:

a copy of this element

accept

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

Specified by:

accept in interface GraphQLSchemaElement

getChildren

public 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

equals

public final boolean equals(Object o)

No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

equals in interface GraphQLSchemaElement

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public final int hashCode()

No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

hashCode in interface GraphQLSchemaElement

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

newFieldDefinition

public static GraphQLFieldDefinition.Builder newFieldDefinition(GraphQLFieldDefinition existing)

newFieldDefinition

public static GraphQLFieldDefinition.Builder newFieldDefinition()