graphql.schema

Class GraphQLInputObjectField

java.lang.Object

graphql.schema.GraphQLInputObjectField

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLType

@PublicApi
public class GraphQLInputObjectField
extends java.lang.Object
implements GraphQLDirectiveContainer

Input objects defined via GraphQLInputObjectType contains these input fields. There are similar to GraphQLFieldDefinition however they can ONLY be used on input objects, that is to describe values that are fed into a graphql mutation. See http://graphql.org/learn/schema/#input-types for more details on the concept.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLInputObjectField.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLInputObjectField(java.lang.String name, GraphQLInputType type) Deprecated. use the newInputObjectField() builder pattern instead, as this constructor will be made private in a future version.
GraphQLInputObjectField(java.lang.String name, java.lang.String description, GraphQLInputType type, java.lang.Object defaultValue) Deprecated. use the newInputObjectField() builder pattern instead, as this constructor will be made private in a future version.
GraphQLInputObjectField(java.lang.String name, java.lang.String description, GraphQLInputType type, java.lang.Object defaultValue, java.util.List<GraphQLDirective> directives, InputValueDefinition definition) Deprecated. use the newInputObjectField() builder pattern instead, as this constructor will be made private in a future version.

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
java.util.List<GraphQLType>	getChildren()
java.lang.Object	getDefaultValue()
InputValueDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.lang.String	getName()
GraphQLInputType	getType()
static GraphQLInputObjectField.Builder	newInputObjectField()
static GraphQLInputObjectField.Builder	newInputObjectField(GraphQLInputObjectField existing)
GraphQLInputObjectField	transform(java.util.function.Consumer<GraphQLInputObjectField.Builder> builderConsumer) This helps you transform the current GraphQLInputObjectField into another one by starting a builder with all the current values and allows you to transform it how you want.

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirective, getDirectivesByName

Constructor Detail

GraphQLInputObjectField

@Deprecated
public GraphQLInputObjectField(java.lang.String name,
                                           GraphQLInputType type)

Deprecated. use the newInputObjectField() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

type - the field type

GraphQLInputObjectField

@Deprecated
public GraphQLInputObjectField(java.lang.String name,
                                           java.lang.String description,
                                           GraphQLInputType type,
                                           java.lang.Object defaultValue)

Deprecated. use the newInputObjectField() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

type - the field type

defaultValue - the default value

GraphQLInputObjectField

@Deprecated
public GraphQLInputObjectField(java.lang.String name,
                                           java.lang.String description,
                                           GraphQLInputType type,
                                           java.lang.Object defaultValue,
                                           java.util.List<GraphQLDirective> directives,
                                           InputValueDefinition definition)

Deprecated. use the newInputObjectField() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the name

description - the description

type - the field type

defaultValue - the default value

directives - the directives on this type element

definition - the AST definition

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface GraphQLType

Returns:

the name of the type which MUST fit within the regular expression [_A-Za-z][_0-9A-Za-z]*

getType

public GraphQLInputType getType()

getDefaultValue

public java.lang.Object getDefaultValue()

getDescription

public java.lang.String getDescription()

getDefinition

public InputValueDefinition getDefinition()

getDirectives

public java.util.List<GraphQLDirective> getDirectives()

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

transform

public GraphQLInputObjectField transform(java.util.function.Consumer<GraphQLInputObjectField.Builder> builderConsumer)

This helps you transform the current GraphQLInputObjectField into another one by starting a builder with all the current values and allows you to transform it how you want.

Parameters:

builderConsumer - the consumer code that will be given a builder to transform

Returns:

a new object based on calling build on that builder

accept

public TraversalControl accept(TraverserContext<GraphQLType> context,
                               GraphQLTypeVisitor visitor)

Description copied from interface: GraphQLType

Double-dispatch entry point. It allows to travers a given non-trivial graphQL type and move from root to nested or enclosed types. This implements similar pattern as Node, see accept(...) for more details about the pattern.

Specified by:

accept in interface GraphQLType

Parameters:

context - TraverserContext bound to this graphQL type object

visitor - Visitor instance that performs actual processing on the types(s)

Returns:

Result of Visitor's operation. Note! Visitor's operation might return special results to control traversal process.

getChildren

public java.util.List<GraphQLType> getChildren()

Specified by:

getChildren in interface GraphQLType

Returns:

returns all types directly associated with this node

newInputObjectField

public static GraphQLInputObjectField.Builder newInputObjectField(GraphQLInputObjectField existing)

newInputObjectField

public static GraphQLInputObjectField.Builder newInputObjectField()