Package graphql.schema

Class GraphQLObjectType.Builder

java.lang.Object

graphql.schema.GraphqlTypeBuilder<GraphQLObjectType.Builder>

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

graphql.schema.GraphQLObjectType.Builder

Enclosing class:

GraphQLObjectType

@PublicApi
public static class GraphQLObjectType.Builder
extends GraphqlDirectivesContainerTypeBuilder<GraphQLObjectType.Builder,GraphQLObjectType.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(GraphQLObjectType existing)

Method Summary

Modifier and Type	Method	Description
GraphQLObjectType	build()
GraphQLObjectType.Builder	clearDirectives()	This is used to clear all the directives in the builder so far.
GraphQLObjectType.Builder	clearFields()	This is used to clear all the fields in the builder so far.
GraphQLObjectType.Builder	clearInterfaces()	This is used to clear all the interfaces in the builder so far.
GraphQLObjectType.Builder	definition(ObjectTypeDefinition definition)
GraphQLObjectType.Builder	description(String description)
GraphQLObjectType.Builder	extensionDefinitions(List<ObjectTypeExtensionDefinition> extensionDefinitions)
GraphQLObjectType.Builder	field(GraphQLFieldDefinition fieldDefinition)
GraphQLObjectType.Builder	field(GraphQLFieldDefinition.Builder builder)	Same effect as the field(GraphQLFieldDefinition).
GraphQLObjectType.Builder	field(UnaryOperator<GraphQLFieldDefinition.Builder> builderFunction)	Take a field builder in a function definition and apply.
GraphQLObjectType.Builder	fields(List<GraphQLFieldDefinition> fieldDefinitions)
boolean	hasField(String fieldName)
GraphQLObjectType.Builder	name(String name)
GraphQLObjectType.Builder	replaceDirectives(List<GraphQLDirective> directives)
GraphQLObjectType.Builder	replaceFields(List<GraphQLFieldDefinition> fieldDefinitions)
GraphQLObjectType.Builder	replaceInterfaces(List<? extends GraphQLNamedOutputType> interfaces)
GraphQLObjectType.Builder	withDirective(GraphQLDirective directive)
GraphQLObjectType.Builder	withDirective(GraphQLDirective.Builder builder)
GraphQLObjectType.Builder	withDirectives(GraphQLDirective... directives)
GraphQLObjectType.Builder	withInterface(GraphQLInterfaceType interfaceType)
GraphQLObjectType.Builder	withInterface(GraphQLTypeReference reference)
GraphQLObjectType.Builder	withInterfaces(GraphQLInterfaceType... interfaceType)
GraphQLObjectType.Builder	withInterfaces(GraphQLTypeReference... references)

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(GraphQLObjectType existing)

Method Details

definition

public GraphQLObjectType.Builder definition(ObjectTypeDefinition definition)

extensionDefinitions

public GraphQLObjectType.Builder extensionDefinitions(List<ObjectTypeExtensionDefinition> extensionDefinitions)

field

public GraphQLObjectType.Builder field(GraphQLFieldDefinition fieldDefinition)

field

public GraphQLObjectType.Builder field(UnaryOperator<GraphQLFieldDefinition.Builder> builderFunction)

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

     
      field(f -> f.name("fieldName"))
     
 

Parameters:

builderFunction - a supplier for the builder impl

Returns:

this

field

public GraphQLObjectType.Builder field(GraphQLFieldDefinition.Builder builder)

Same effect as the field(GraphQLFieldDefinition). Builder.build() is called from within

Parameters:

builder - an un-built/incomplete GraphQLFieldDefinition

Returns:

this

fields

public GraphQLObjectType.Builder fields(List<GraphQLFieldDefinition> fieldDefinitions)

replaceFields

public GraphQLObjectType.Builder replaceFields(List<GraphQLFieldDefinition> fieldDefinitions)

clearFields

public GraphQLObjectType.Builder clearFields()

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

Returns:

the builder

hasField

public boolean hasField(String fieldName)

withInterface

public GraphQLObjectType.Builder withInterface(GraphQLInterfaceType interfaceType)

replaceInterfaces

public GraphQLObjectType.Builder replaceInterfaces(List<? extends GraphQLNamedOutputType> interfaces)

withInterface

public GraphQLObjectType.Builder withInterface(GraphQLTypeReference reference)

withInterfaces

public GraphQLObjectType.Builder withInterfaces(GraphQLInterfaceType... interfaceType)

withInterfaces

public GraphQLObjectType.Builder withInterfaces(GraphQLTypeReference... references)

clearInterfaces

public GraphQLObjectType.Builder clearInterfaces()

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

Returns:

the builder

replaceDirectives

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

Overrides:

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

Parameters:

directives - the list of directives

Returns:

this builder

withDirectives

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

Overrides:

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

Parameters:

directives - the variable args of directives

Returns:

this builder

withDirective

public GraphQLObjectType.Builder withDirective(GraphQLDirective directive)

Overrides:

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

Parameters:

directive - the directive to add

Returns:

this builder

withDirective

public GraphQLObjectType.Builder withDirective(GraphQLDirective.Builder builder)

Overrides:

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

Parameters:

builder - the directive builder

Returns:

this builder

clearDirectives

public GraphQLObjectType.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<GraphQLObjectType.Builder,GraphQLObjectType.Builder>

Returns:

the builder

name

public GraphQLObjectType.Builder name(String name)

Overrides:

name in class GraphqlTypeBuilder<GraphQLObjectType.Builder>

description

public GraphQLObjectType.Builder description(String description)

Overrides:

description in class GraphqlTypeBuilder<GraphQLObjectType.Builder>

build

public GraphQLObjectType build()