Package graphql.schema

Class GraphQLFieldDefinition.Builder

java.lang.Object

graphql.schema.GraphqlTypeBuilder<GraphQLFieldDefinition.Builder>

graphql.schema.GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

graphql.schema.GraphQLFieldDefinition.Builder

Enclosing class:

GraphQLFieldDefinition

@PublicApi
@NullUnmarked
public static class GraphQLFieldDefinition.Builder
extends GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

Field Summary

Fields inherited from class graphql.schema.GraphqlDirectivesContainerTypeBuilder

appliedDirectives, directives

Fields inherited from class graphql.schema.GraphqlTypeBuilder

comparatorRegistry, description, name

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(GraphQLFieldDefinition existing)

Method Summary

Modifier and Type	Method	Description
GraphQLFieldDefinition.Builder	argument(GraphQLArgument argument)
GraphQLFieldDefinition.Builder	argument(GraphQLArgument.Builder builder)	Same effect as the argument(GraphQLArgument).
GraphQLFieldDefinition.Builder	argument(UnaryOperator<GraphQLArgument.Builder> builderFunction)	Take an argument builder in a function definition and apply.
GraphQLFieldDefinition.Builder	argument(List<GraphQLArgument> arguments)	Deprecated. This is a badly named method and is replaced by arguments(java.util.List)
GraphQLFieldDefinition.Builder	arguments(List<GraphQLArgument> arguments)	This adds the list of arguments to the field.
GraphQLFieldDefinition	build()
GraphQLFieldDefinition.Builder	clearArguments()	This is used to clear all the arguments in the builder so far.
GraphQLFieldDefinition.Builder	clearDirectives()	This is used to clear all the directives in the builder so far.
GraphQLFieldDefinition.Builder	dataFetcher(DataFetcher<?> dataFetcher)	Deprecated. use GraphQLCodeRegistry instead
GraphQLFieldDefinition.Builder	dataFetcherFactory(DataFetcherFactory<?> dataFetcherFactory)	Deprecated. use GraphQLCodeRegistry instead
GraphQLFieldDefinition.Builder	definition(FieldDefinition definition)
GraphQLFieldDefinition.Builder	deprecate(String deprecationReason)
GraphQLFieldDefinition.Builder	description(String description)
GraphQLFieldDefinition.Builder	name(String name)
GraphQLFieldDefinition.Builder	replaceArguments(List<GraphQLArgument> arguments)
GraphQLFieldDefinition.Builder	replaceDirectives(List<GraphQLDirective> directives)
GraphQLFieldDefinition.Builder	staticValue(Object value)	Deprecated. use GraphQLCodeRegistry instead
GraphQLFieldDefinition.Builder	type(GraphQLInterfaceType.Builder builder)
GraphQLFieldDefinition.Builder	type(GraphQLObjectType.Builder builder)
GraphQLFieldDefinition.Builder	type(GraphQLOutputType type)
GraphQLFieldDefinition.Builder	type(GraphQLUnionType.Builder builder)
GraphQLFieldDefinition.Builder	withDirective(GraphQLDirective directive)
GraphQLFieldDefinition.Builder	withDirective(GraphQLDirective.Builder builder)
GraphQLFieldDefinition.Builder	withDirectives(GraphQLDirective... directives)

Methods inherited from class graphql.schema.GraphqlDirectivesContainerTypeBuilder

copyExistingDirectives, replaceAppliedDirectives, withAppliedDirective, withAppliedDirective, withAppliedDirectives

Methods inherited from class graphql.schema.GraphqlTypeBuilder

comparatorRegistry

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Builder

public Builder(GraphQLFieldDefinition existing)

Method Details

definition

public GraphQLFieldDefinition.Builder definition(FieldDefinition definition)

type

public GraphQLFieldDefinition.Builder type(GraphQLObjectType.Builder builder)

type

public GraphQLFieldDefinition.Builder type(GraphQLInterfaceType.Builder builder)

type

public GraphQLFieldDefinition.Builder type(GraphQLUnionType.Builder builder)

type

public GraphQLFieldDefinition.Builder type(GraphQLOutputType type)

dataFetcher

@Deprecated(since="2018-12-03")
public GraphQLFieldDefinition.Builder dataFetcher(DataFetcher<?> dataFetcher)

Deprecated.

use GraphQLCodeRegistry instead

Sets the DataFetcher to use with this field.

Parameters:

dataFetcher - the data fetcher to use

Returns:

this builder

dataFetcherFactory

@Deprecated(since="2018-12-03")
public GraphQLFieldDefinition.Builder dataFetcherFactory(DataFetcherFactory<?> dataFetcherFactory)

Deprecated.

use GraphQLCodeRegistry instead

Sets the DataFetcherFactory to use with this field.

Parameters:

dataFetcherFactory - the data fetcher factory

Returns:

this builder

staticValue

@Deprecated(since="2018-12-03")
public GraphQLFieldDefinition.Builder staticValue(Object value)

Deprecated.

use GraphQLCodeRegistry instead

This will cause the data fetcher of this field to always return the supplied value

Parameters:

value - the value to always return

Returns:

this builder

argument

public GraphQLFieldDefinition.Builder argument(GraphQLArgument argument)

argument

public GraphQLFieldDefinition.Builder argument(UnaryOperator<GraphQLArgument.Builder> builderFunction)

Take an argument builder in a function definition and apply. Can be used in a jdk8 lambda e.g.:

     
      argument(a -> a.name("argumentName"))
     
 

Parameters:

builderFunction - a supplier for the builder impl

Returns:

this

argument

public GraphQLFieldDefinition.Builder argument(GraphQLArgument.Builder builder)

Same effect as the argument(GraphQLArgument). Builder.build() is called from within

Parameters:

builder - an un-built/incomplete GraphQLArgument

Returns:

this

argument

@Deprecated(since="2019-02-06")
public GraphQLFieldDefinition.Builder argument(List<GraphQLArgument> arguments)

Deprecated.

This is a badly named method and is replaced by arguments(java.util.List)

This adds the list of arguments to the field.

Parameters:

arguments - the arguments to add

Returns:

this

arguments

public GraphQLFieldDefinition.Builder arguments(List<GraphQLArgument> arguments)

This adds the list of arguments to the field.

Parameters:

arguments - the arguments to add

Returns:

this

replaceArguments

public GraphQLFieldDefinition.Builder replaceArguments(List<GraphQLArgument> arguments)

clearArguments

public GraphQLFieldDefinition.Builder clearArguments()

This is used to clear all the arguments in the builder so far.

Returns:

the builder

deprecate

public GraphQLFieldDefinition.Builder deprecate(String deprecationReason)

replaceDirectives

public GraphQLFieldDefinition.Builder replaceDirectives(List<GraphQLDirective> directives)

Overrides:

replaceDirectives in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

Parameters:

directives - the list of directives

Returns:

this builder

withDirectives

public GraphQLFieldDefinition.Builder withDirectives(GraphQLDirective... directives)

Overrides:

withDirectives in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

Parameters:

directives - the variable args of directives

Returns:

this builder

withDirective

public GraphQLFieldDefinition.Builder withDirective(GraphQLDirective directive)

Overrides:

withDirective in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

Parameters:

directive - the directive to add

Returns:

this builder

withDirective

public GraphQLFieldDefinition.Builder withDirective(GraphQLDirective.Builder builder)

Overrides:

withDirective in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

Parameters:

builder - the directive builder

Returns:

this builder

clearDirectives

public GraphQLFieldDefinition.Builder clearDirectives()

Description copied from class: GraphqlDirectivesContainerTypeBuilder

This is used to clear all the directives in the builder so far.

Overrides:

clearDirectives in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>

Returns:

the builder

name

public GraphQLFieldDefinition.Builder name(String name)

Overrides:

name in class GraphqlTypeBuilder<GraphQLFieldDefinition.Builder>

description

public GraphQLFieldDefinition.Builder description(String description)

Overrides:

description in class GraphqlTypeBuilder<GraphQLFieldDefinition.Builder>

build

public GraphQLFieldDefinition build()