GraphQLFieldDefinition.Builder (graphql-java 18.6 API)

java.lang.Object
- graphql.schema.GraphqlTypeBuilder<BASE>
- - graphql.schema.GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>
  - - graphql.schema.GraphQLFieldDefinition.Builder

Enclosing class:: GraphQLFieldDefinition

@PublicApi
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 and Description

Builder()

Builder(GraphQLFieldDefinition existing)

Constructors
Constructor and Description
`Builder()`
`Builder(GraphQLFieldDefinition existing)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`GraphQLFieldDefinition.Builder`	`argument(GraphQLArgument.Builder builder)` Same effect as the argument(GraphQLArgument).
`GraphQLFieldDefinition.Builder`	`argument(GraphQLArgument argument)`
`GraphQLFieldDefinition.Builder`	`argument(java.util.List<GraphQLArgument> arguments)` Deprecated. This is a badly named method and is replaced by `arguments(java.util.List)`
`GraphQLFieldDefinition.Builder`	`argument(java.util.function.UnaryOperator<GraphQLArgument.Builder> builderFunction)` Take an argument builder in a function definition and apply.
`GraphQLFieldDefinition.Builder`	`arguments(java.util.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(java.lang.String deprecationReason)`
`GraphQLFieldDefinition.Builder`	`description(java.lang.String description)`
`GraphQLFieldDefinition.Builder`	`name(java.lang.String name)`
`GraphQLFieldDefinition.Builder`	`replaceArguments(java.util.List<GraphQLArgument> arguments)`
`GraphQLFieldDefinition.Builder`	`replaceDirectives(java.util.List<GraphQLDirective> directives)`
`GraphQLFieldDefinition.Builder`	`staticValue(java.lang.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.Builder builder)`
`GraphQLFieldDefinition.Builder`	`withDirective(GraphQLDirective directive)`
`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 Detail
  - Builder
```
public Builder()
```
  - Builder
```
public Builder(GraphQLFieldDefinition existing)
```
- Method Detail
  - 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
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
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
public GraphQLFieldDefinition.Builder staticValue(java.lang.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(java.util.function.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
public GraphQLFieldDefinition.Builder argument(java.util.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(java.util.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(java.util.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(java.lang.String deprecationReason)
```
  - replaceDirectives
```
public GraphQLFieldDefinition.Builder replaceDirectives(java.util.List<GraphQLDirective> directives)
```
    Overrides:
    
    replaceDirectives in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>
  - withDirectives
```
public GraphQLFieldDefinition.Builder withDirectives(GraphQLDirective... directives)
```
    Overrides:
    
    withDirectives in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>
  - withDirective
```
public GraphQLFieldDefinition.Builder withDirective(GraphQLDirective directive)
```
    Overrides:
    
    withDirective in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.Builder>
  - withDirective
```
public GraphQLFieldDefinition.Builder withDirective(GraphQLDirective.Builder builder)
```
    Overrides:
    
    withDirective in class GraphqlDirectivesContainerTypeBuilder<GraphQLFieldDefinition.Builder,GraphQLFieldDefinition.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(java.lang.String name)
```
    Overrides:
    
    name in class GraphqlTypeBuilder<GraphQLFieldDefinition.Builder>
  - description
```
public GraphQLFieldDefinition.Builder description(java.lang.String description)
```
    Overrides:
    
    description in class GraphqlTypeBuilder<GraphQLFieldDefinition.Builder>
  - build
```
public GraphQLFieldDefinition build()
```

Class GraphQLFieldDefinition.Builder

Field Summary

Fields inherited from class graphql.schema.GraphqlDirectivesContainerTypeBuilder

Fields inherited from class graphql.schema.GraphqlTypeBuilder

Constructor Summary

Method Summary

Methods inherited from class graphql.schema.GraphqlDirectivesContainerTypeBuilder

Methods inherited from class graphql.schema.GraphqlTypeBuilder

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

definition

type

type

type

type

dataFetcher

dataFetcherFactory

staticValue

argument

argument

argument

argument

arguments

replaceArguments

clearArguments

deprecate

replaceDirectives

withDirectives

withDirective

withDirective

clearDirectives

name

description

build