Class GraphQLInputObjectType

java.lang.Object

graphql.schema.GraphQLInputObjectType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputFieldsContainer, GraphQLInputSchemaElement, GraphQLInputType, GraphQLNamedInputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType

@PublicApi
public class GraphQLInputObjectType
extends Object
implements GraphQLNamedInputType, 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 https://graphql.org/learn/schema/#input-types for more details on the concept

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphQLInputObjectType.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILD_FIELD_DEFINITIONS
private final InputObjectTypeDefinition	definition
private final String	description
private final DirectivesUtil.DirectivesHolder	directives
private final com.google.common.collect.ImmutableList<InputObjectTypeExtensionDefinition>	extensionDefinitions
private final com.google.common.collect.ImmutableMap<String, GraphQLInputObjectField>	fieldMap
private final boolean	isOneOf
private final String	name

Fields inherited from interface GraphQLDirectiveContainer

CHILD_APPLIED_DIRECTIVES, CHILD_DIRECTIVES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GraphQLInputObjectType(String name, String description, List<GraphQLInputObjectField> fields, List<GraphQLDirective> directives, List<GraphQLAppliedDirective> appliedDirectives, InputObjectTypeDefinition definition, List<InputObjectTypeExtensionDefinition> extensionDefinitions)

Method Summary

Modifier and Type	Method	Description
TraversalControl	accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
private com.google.common.collect.ImmutableMap<String, GraphQLInputObjectField>	buildDefinitionMap(List<GraphQLInputObjectField> fieldDefinitions)
GraphQLSchemaElement	copy()	Each GraphQLSchemaElement should make a copy of itself when this is called.
final boolean	equals(Object o)	No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
Map<String, List<GraphQLAppliedDirective>>	getAllAppliedDirectivesByName()	This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.
Map<String, List<GraphQLDirective>>	getAllDirectivesByName()	This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.
GraphQLAppliedDirective	getAppliedDirective(String directiveName)	Returns a non-repeatable directive with the provided name.
List<GraphQLAppliedDirective>	getAppliedDirectives()	This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.
List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
InputObjectTypeDefinition	getDefinition()	The AST Node this schema element is based on.
String	getDescription()
GraphQLDirective	getDirective(String directiveName)	Returns a non-repeatable directive with the provided name.
List<GraphQLDirective>	getDirectives()	This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.
Map<String, GraphQLDirective>	getDirectivesByName()	This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement.
List<InputObjectTypeExtensionDefinition>	getExtensionDefinitions()
GraphQLInputObjectField	getField(String name)
GraphQLInputObjectField	getFieldDefinition(String name)
List<GraphQLInputObjectField>	getFieldDefinitions()
List<GraphQLInputObjectField>	getFields()
String	getName()
final int	hashCode()	No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
private boolean	hasOneOf(List<GraphQLDirective> directives, List<GraphQLAppliedDirective> appliedDirectives)
boolean	isOneOf()	An Input Object is considered a OneOf Input Object if it has the `@oneOf` directive applied to it.
static GraphQLInputObjectType.Builder	newInputObject()
static GraphQLInputObjectType.Builder	newInputObject(GraphQLInputObjectType existing)
String	toString()
GraphQLInputObjectType	transform(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.
GraphQLInputObjectType	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GraphQLDirectiveContainer

getAppliedDirectives, getDirectives, hasAppliedDirective, hasDirective

Field Details

name

private final String name

isOneOf

private final boolean isOneOf

description

private final String description

fieldMap

private final com.google.common.collect.ImmutableMap<String, GraphQLInputObjectField> fieldMap

definition

private final InputObjectTypeDefinition definition

extensionDefinitions

private final com.google.common.collect.ImmutableList<InputObjectTypeExtensionDefinition> extensionDefinitions

directives

private final DirectivesUtil.DirectivesHolder directives

CHILD_FIELD_DEFINITIONS

public static final String CHILD_FIELD_DEFINITIONS

See Also:

• Constant Field Values

Constructor Details

GraphQLInputObjectType

private GraphQLInputObjectType(String name,
 String description,
 List<GraphQLInputObjectField> fields,
 List<GraphQLDirective> directives,
 List<GraphQLAppliedDirective> appliedDirectives,
 InputObjectTypeDefinition definition,
 List<InputObjectTypeExtensionDefinition> extensionDefinitions)

Method Details

buildDefinitionMap

private com.google.common.collect.ImmutableMap<String, GraphQLInputObjectField> buildDefinitionMap(List<GraphQLInputObjectField> fieldDefinitions)

hasOneOf

private boolean hasOneOf(List<GraphQLDirective> directives,
 List<GraphQLAppliedDirective> appliedDirectives)

getName

public String getName()

Specified by:

getName in interface GraphQLNamedSchemaElement

Returns:

the name of this element. This cant be null

isOneOf

@ExperimentalApi
public boolean isOneOf()

An Input Object is considered a OneOf Input Object if it has the `@oneOf` directive applied to it.

This API is currently considered experimental since the graphql specification has not yet ratified this approach.

Returns:

true if it's a OneOf Input Object

getDescription

public String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

Returns:

the description of this element. This can be null

getFields

public List<GraphQLInputObjectField> getFields()

getField

public GraphQLInputObjectField getField(String name)

getDirectives

public List<GraphQLDirective> getDirectives()

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getDirectivesByName

public Map<String, GraphQLDirective> getDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the non repeatable directives that are associated with a GraphQLNamedSchemaElement. Any repeatable directives will be filtered out of this map.

Specified by:

getDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of non repeatable directives by directive name.

getAllDirectivesByName

public Map<String, List<GraphQLDirective>> getAllDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non repeatable directives.

Specified by:

getAllDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getDirective

public GraphQLDirective getDirective(String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non-repeatable directive with the provided name. This will throw a AssertException if the directive is a repeatable directive that has more then one instance.

Specified by:

getDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

the directive or null if there is not one with that name

getAppliedDirectives

public List<GraphQLAppliedDirective> getAppliedDirectives()

Description copied from interface: GraphQLDirectiveContainer

This will return a list of all the directives that have been put on GraphQLNamedSchemaElement as a flat list, which may contain repeatable and non-repeatable directives.

Specified by:

getAppliedDirectives in interface GraphQLDirectiveContainer

Returns:

a list of all the directives associated with this named schema element

getAllAppliedDirectivesByName

public Map<String, List<GraphQLAppliedDirective>> getAllAppliedDirectivesByName()

Description copied from interface: GraphQLDirectiveContainer

This will return a Map of the all directives that are associated with a GraphQLNamedSchemaElement, including both repeatable and non-repeatable directives.

Specified by:

getAllAppliedDirectivesByName in interface GraphQLDirectiveContainer

Returns:

a map of all directives by directive name

getAppliedDirective

public GraphQLAppliedDirective getAppliedDirective(String directiveName)

Description copied from interface: GraphQLDirectiveContainer

Returns a non-repeatable directive with the provided name.

Specified by:

getAppliedDirective in interface GraphQLDirectiveContainer

Parameters:

directiveName - the name of the directive to retrieve

Returns:

the directive or null if there is not one with that name

getFieldDefinition

public GraphQLInputObjectField getFieldDefinition(String name)

Specified by:

getFieldDefinition in interface GraphQLInputFieldsContainer

getFieldDefinitions

public List<GraphQLInputObjectField> getFieldDefinitions()

Specified by:

getFieldDefinitions in interface GraphQLInputFieldsContainer

getDefinition

public InputObjectTypeDefinition getDefinition()

Description copied from interface: GraphQLNamedSchemaElement

The AST Node this schema element is based on. Is null if the GraphQLSchema is not based on a SDL document. Some elements also have additional extension Nodes. See for example GraphQLObjectType.getExtensionDefinitions()

Specified by:

getDefinition in interface GraphQLNamedSchemaElement

Returns:

Node which this element is based on. Can be null.

getExtensionDefinitions

public List<InputObjectTypeExtensionDefinition> getExtensionDefinitions()

transform

public GraphQLInputObjectType transform(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

copy

public GraphQLSchemaElement copy()

Description copied from interface: GraphQLSchemaElement

Each GraphQLSchemaElement should make a copy of itself when this is called. The copy should be included its current contents as they currently exist into a new object.

Specified by:

copy in interface GraphQLSchemaElement

Returns:

a copy of this element

accept

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

Specified by:

accept in interface GraphQLSchemaElement

getChildren

public List<GraphQLSchemaElement> getChildren()

Specified by:

getChildren in interface GraphQLSchemaElement

getChildrenWithTypeReferences

public SchemaElementChildrenContainer getChildrenWithTypeReferences()

Specified by:

getChildrenWithTypeReferences in interface GraphQLSchemaElement

withNewChildren

public GraphQLInputObjectType withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

equals

public final boolean equals(Object o)

No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

equals in interface GraphQLSchemaElement

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public final int hashCode()

No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.

Specified by:

hashCode in interface GraphQLSchemaElement

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

toString

public String toString()

Overrides:

toString in class Object

newInputObject

public static GraphQLInputObjectType.Builder newInputObject(GraphQLInputObjectType existing)

newInputObject

public static GraphQLInputObjectType.Builder newInputObject()