graphql.schema

Class GraphQLArgument.Builder

java.lang.Object

graphql.schema.GraphqlTypeBuilder

graphql.schema.GraphQLArgument.Builder

Enclosing class:

GraphQLArgument

public static class GraphQLArgument.Builder
extends GraphqlTypeBuilder

Field Summary

Fields inherited from class graphql.schema.GraphqlTypeBuilder

comparatorRegistry, description, name

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(GraphQLArgument existing)

Method Summary

Modifier and Type	Method and 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() Removes the value to represent a missing value (which is different from null)
GraphQLArgument.Builder	comparatorRegistry(GraphqlTypeComparatorRegistry comparatorRegistry)
GraphQLArgument.Builder	defaultValue(java.lang.Object defaultValue) Deprecated. use defaultValueLiteral(Value) or defaultValueProgrammatic(Object)
GraphQLArgument.Builder	defaultValueLiteral(@NotNull Value defaultValue)
GraphQLArgument.Builder	defaultValueProgrammatic(@Nullable java.lang.Object defaultValue)
GraphQLArgument.Builder	definition(InputValueDefinition definition)
GraphQLArgument.Builder	deprecate(java.lang.String deprecationReason)
GraphQLArgument.Builder	description(java.lang.String description)
GraphQLArgument.Builder	name(java.lang.String name)
GraphQLArgument.Builder	replaceDirectives(java.util.List<GraphQLDirective> directives)
GraphQLArgument.Builder	type(GraphQLInputType type)
GraphQLArgument.Builder	value(@Nullable java.lang.Object value) Deprecated. use valueLiteral(Value) or valueProgrammatic(Object)
GraphQLArgument.Builder	valueLiteral(@NotNull Value value) Sets a literal AST value as the arguments value
GraphQLArgument.Builder	valueProgrammatic(@Nullable java.lang.Object value)
GraphQLArgument.Builder	withDirective(GraphQLDirective.Builder builder)
GraphQLArgument.Builder	withDirective(GraphQLDirective directive)
GraphQLArgument.Builder	withDirectives(GraphQLDirective... directives)

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

Method Detail

name

public GraphQLArgument.Builder name(java.lang.String name)

description

public GraphQLArgument.Builder description(java.lang.String description)

comparatorRegistry

public GraphQLArgument.Builder comparatorRegistry(GraphqlTypeComparatorRegistry comparatorRegistry)

definition

public GraphQLArgument.Builder definition(InputValueDefinition definition)

deprecate

public GraphQLArgument.Builder deprecate(java.lang.String deprecationReason)

type

public GraphQLArgument.Builder type(GraphQLInputType type)

defaultValue

@Deprecated
public GraphQLArgument.Builder defaultValue(java.lang.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(@NotNull
                                                   @NotNull 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
                                                        @Nullable java.lang.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
public GraphQLArgument.Builder value(@Nullable
                                                 @Nullable java.lang.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

public GraphQLArgument.Builder valueLiteral(@NotNull
                                            @NotNull Value value)

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

public GraphQLArgument.Builder valueProgrammatic(@Nullable
                                                 @Nullable java.lang.Object value)

Parameters:

value - values can be null to represent null value

Returns:

this builder

clearValue

public GraphQLArgument.Builder clearValue()

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

Returns:

this builder

withDirectives

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

withDirective

public GraphQLArgument.Builder withDirective(GraphQLDirective directive)

replaceDirectives

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

withDirective

public GraphQLArgument.Builder withDirective(GraphQLDirective.Builder builder)

clearDirectives

public GraphQLArgument.Builder clearDirectives()

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

Returns:

the builder

build

public GraphQLArgument build()