Package graphql.schema

Class GraphQLArgument.Builder

java.lang.Object

graphql.schema.GraphqlTypeBuilder<GraphQLArgument.Builder>

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

graphql.schema.GraphQLArgument.Builder

Enclosing class:

GraphQLArgument

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

Method Summary

Modifier and Type	Method	Description
GraphQLArgument	build()
GraphQLArgument.Builder	clearDefaultValue()	Removes the defaultValue to represent a missing default value (which is different from null)
GraphQLArgument.Builder	clearDirectives()	This is used to clear all the directives in the builder so far.
GraphQLArgument.Builder	clearValue()	Deprecated. use GraphQLAppliedDirectiveArgument methods instead
GraphQLArgument.Builder	defaultValue(Object defaultValue)	Deprecated. use defaultValueLiteral(Value) or defaultValueProgrammatic(Object)
GraphQLArgument.Builder	defaultValueLiteral(@NonNull Value defaultValue)
GraphQLArgument.Builder	defaultValueProgrammatic(@Nullable Object defaultValue)
GraphQLArgument.Builder	definition(InputValueDefinition definition)
GraphQLArgument.Builder	deprecate(String deprecationReason)
GraphQLArgument.Builder	description(String description)
GraphQLArgument.Builder	name(String name)
GraphQLArgument.Builder	replaceDirectives(List<GraphQLDirective> directives)
GraphQLArgument.Builder	type(GraphQLInputType type)
GraphQLArgument.Builder	value(@Nullable Object value)	Deprecated. use valueLiteral(Value) or valueProgrammatic(Object)
GraphQLArgument.Builder	valueLiteral(@NonNull Value value)	Deprecated. use GraphQLAppliedDirectiveArgument methods instead
GraphQLArgument.Builder	valueProgrammatic(@Nullable Object value)	Deprecated. use GraphQLAppliedDirectiveArgument methods instead
GraphQLArgument.Builder	withDirective(GraphQLDirective directive)
GraphQLArgument.Builder	withDirective(GraphQLDirective.Builder builder)
GraphQLArgument.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(GraphQLArgument existing)

Method Details

definition

public GraphQLArgument.Builder definition(InputValueDefinition definition)

deprecate

public GraphQLArgument.Builder deprecate(String deprecationReason)

type

public GraphQLArgument.Builder type(GraphQLInputType type)

defaultValue

@Deprecated(since="2021-05-10")
public GraphQLArgument.Builder defaultValue(Object defaultValue)

Deprecated.

use defaultValueLiteral(Value) or defaultValueProgrammatic(Object)

A legacy method that sets a default value into the argument

Parameters:

defaultValue - a default value

Returns:

this builder

defaultValueLiteral

public GraphQLArgument.Builder defaultValueLiteral(@NonNull Value defaultValue)

Parameters:

defaultValue - can't be null as a `null` is represented a @NullValue Literal

Returns:

this builder

defaultValueProgrammatic

public GraphQLArgument.Builder defaultValueProgrammatic(@Nullable Object defaultValue)

Parameters:

defaultValue - Can be null to represent null value

Returns:

this builder

clearDefaultValue

public GraphQLArgument.Builder clearDefaultValue()

Removes the defaultValue to represent a missing default value (which is different from null)

Returns:

this builder

value

@Deprecated(since="2021-05-10")
public GraphQLArgument.Builder value(@Nullable Object value)

Deprecated.

use valueLiteral(Value) or valueProgrammatic(Object)

A legacy method for setting an arguments value

Parameters:

value - the argument value

Returns:

this builder

valueLiteral

@Deprecated(since="2022-02-24")
public GraphQLArgument.Builder valueLiteral(@NonNull Value value)

Deprecated.

use GraphQLAppliedDirectiveArgument methods instead

Sets a literal AST value as the arguments value

Parameters:

value - can't be null as a `null` is represented a @NullValue Literal

Returns:

this builder

valueProgrammatic

@Deprecated(since="2022-02-24")
public GraphQLArgument.Builder valueProgrammatic(@Nullable Object value)

Deprecated.

use GraphQLAppliedDirectiveArgument methods instead

Parameters:

value - values can be null to represent null value

Returns:

this builder

clearValue

@Deprecated(since="2022-02-24")
public GraphQLArgument.Builder clearValue()

Deprecated.

use GraphQLAppliedDirectiveArgument methods instead

Removes the value to represent a missing value (which is different from null)

Returns:

this builder

replaceDirectives

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

Overrides:

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

Parameters:

directives - the list of directives

Returns:

this builder

withDirectives

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

Overrides:

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

Parameters:

directives - the variable args of directives

Returns:

this builder

withDirective

public GraphQLArgument.Builder withDirective(GraphQLDirective directive)

Overrides:

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

Parameters:

directive - the directive to add

Returns:

this builder

withDirective

public GraphQLArgument.Builder withDirective(GraphQLDirective.Builder builder)

Overrides:

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

Parameters:

builder - the directive builder

Returns:

this builder

clearDirectives

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

Returns:

the builder

name

public GraphQLArgument.Builder name(String name)

Overrides:

name in class GraphqlTypeBuilder<GraphQLArgument.Builder>

description

public GraphQLArgument.Builder description(String description)

Overrides:

description in class GraphqlTypeBuilder<GraphQLArgument.Builder>

build

public GraphQLArgument build()