graphql.schema

Class GraphQLInputObjectType

java.lang.Object

graphql.schema.GraphQLInputObjectType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputFieldsContainer, GraphQLInputType, GraphQLNullableType, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLInputObjectType
extends java.lang.Object
implements GraphQLType, GraphQLInputType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLInputFieldsContainer, GraphQLDirectiveContainer

graphql clearly delineates between the types of objects that represent the output of a query and input objects that can be fed into a graphql mutation. You can define objects as input to graphql via this class 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	GraphQLInputObjectType.Builder

Constructor Summary

Constructors

Constructor and Description
GraphQLInputObjectType(java.lang.String name, java.lang.String description, java.util.List<GraphQLInputObjectField> fields)
GraphQLInputObjectType(java.lang.String name, java.lang.String description, java.util.List<GraphQLInputObjectField> fields, java.util.List<GraphQLDirective> directives, InputObjectTypeDefinition definition)

Method Summary

Modifier and Type	Method and Description
TraversalControl	accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor) Double-dispatch entry point.
java.util.List<GraphQLType>	getChildren()
InputObjectTypeDefinition	getDefinition()
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
GraphQLInputObjectField	getField(java.lang.String name)
GraphQLInputObjectField	getFieldDefinition(java.lang.String name)
java.util.List<GraphQLInputObjectField>	getFieldDefinitions()
java.util.List<GraphQLInputObjectField>	getFields()
java.lang.String	getName()
static GraphQLInputObjectType.Builder	newInputObject()
static GraphQLInputObjectType.Builder	newInputObject(GraphQLInputObjectType existing)
GraphQLInputObjectType	transform(java.util.function.Consumer<GraphQLInputObjectType.Builder> builderConsumer) This helps you transform the current GraphQLInputObjectType 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

GraphQLInputObjectType

public GraphQLInputObjectType(java.lang.String name,
                              java.lang.String description,
                              java.util.List<GraphQLInputObjectField> fields)

GraphQLInputObjectType

public GraphQLInputObjectType(java.lang.String name,
                              java.lang.String description,
                              java.util.List<GraphQLInputObjectField> fields,
                              java.util.List<GraphQLDirective> directives,
                              InputObjectTypeDefinition 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]*

getDescription

public java.lang.String getDescription()

getFields

public java.util.List<GraphQLInputObjectField> getFields()

getField

public GraphQLInputObjectField getField(java.lang.String name)

getDirectives

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

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

getFieldDefinition

public GraphQLInputObjectField getFieldDefinition(java.lang.String name)

Specified by:

getFieldDefinition in interface GraphQLInputFieldsContainer

getFieldDefinitions

public java.util.List<GraphQLInputObjectField> getFieldDefinitions()

Specified by:

getFieldDefinitions in interface GraphQLInputFieldsContainer

getDefinition

public InputObjectTypeDefinition getDefinition()

transform

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

This helps you transform the current GraphQLInputObjectType 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

newInputObject

public static GraphQLInputObjectType.Builder newInputObject(GraphQLInputObjectType existing)

newInputObject

public static GraphQLInputObjectType.Builder newInputObject()