GraphQLInputObjectType (graphql-java 17.0 API)

java.lang.Object
- graphql.schema.GraphQLInputObjectType

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputFieldsContainer, GraphQLInputType, GraphQLNamedInputType, GraphQLNamedSchemaElement, GraphQLNamedType, GraphQLNullableType, GraphQLSchemaElement, GraphQLType, GraphQLUnmodifiedType
```
@PublicApi
public class GraphQLInputObjectType
extends java.lang.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 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`GraphQLInputObjectType.Builder`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CHILD_DIRECTIVES

static java.lang.String CHILD_FIELD_DEFINITIONS

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHILD_DIRECTIVES`
`static java.lang.String`	`CHILD_FIELD_DEFINITIONS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TraversalControl`	`accept(TraverserContext<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)`
`GraphQLSchemaElement`	`copy()` Each GraphQLSchemaElement should make a copy of itself when this is called.
`boolean`	`equals(java.lang.Object o)` No GraphQLSchemaElement implements `equals` because we need object identity to treat a GraphQLSchema as an abstract graph.
`java.util.Map<java.lang.String,java.util.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.
`java.util.List<GraphQLSchemaElement>`	`getChildren()`
`SchemaElementChildrenContainer`	`getChildrenWithTypeReferences()`
`InputObjectTypeDefinition`	`getDefinition()` The AST `Node` this schema element is based on.
`java.lang.String`	`getDescription()`
`GraphQLDirective`	`getDirective(java.lang.String directiveName)` Returns a non repeatable directive with the provided name.
`java.util.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.
`java.util.Map<java.lang.String,GraphQLDirective>`	`getDirectivesByName()` This will return a Map of the non repeatable directives that are associated with a `GraphQLNamedSchemaElement`.
`java.util.List<InputObjectTypeExtensionDefinition>`	`getExtensionDefinitions()`
`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()`
`int`	`hashCode()` No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
`static GraphQLInputObjectType.Builder`	`newInputObject()`
`static GraphQLInputObjectType.Builder`	`newInputObject(GraphQLInputObjectType existing)`
`java.lang.String`	`toString()`
`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.
`GraphQLInputObjectType`	`withNewChildren(SchemaElementChildrenContainer newChildren)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer
getDirectives, hasDirective

- Field Detail
  - CHILD_FIELD_DEFINITIONS
```
public static final java.lang.String CHILD_FIELD_DEFINITIONS
```
    See Also:
    
    Constant Field Values
  - CHILD_DIRECTIVES
```
public static final java.lang.String CHILD_DIRECTIVES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface GraphQLNamedSchemaElement
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface GraphQLNamedSchemaElement
  - getFields
```
public java.util.List<GraphQLInputObjectField> getFields()
```
  - getField
```
public GraphQLInputObjectField getField(java.lang.String name)
```
  - getDirectives
```
public java.util.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 java.util.Map<java.lang.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 java.util.Map<java.lang.String,java.util.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(java.lang.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
  - 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()
```
    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 java.util.List<InputObjectTypeExtensionDefinition> getExtensionDefinitions()
```
  - 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
  - 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 include 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 java.util.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(java.lang.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 java.lang.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 java.lang.Object
    
    Returns:
    
    a hash code value for this object.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - newInputObject
```
public static GraphQLInputObjectType.Builder newInputObject(GraphQLInputObjectType existing)
```
  - newInputObject
```
public static GraphQLInputObjectType.Builder newInputObject()
```

Class GraphQLInputObjectType

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

Field Detail

CHILD_FIELD_DEFINITIONS

CHILD_DIRECTIVES

Method Detail

getName

getDescription

getFields

getField

getDirectives

getDirectivesByName

getAllDirectivesByName

getDirective

getFieldDefinition

getFieldDefinitions

getDefinition

getExtensionDefinitions

transform

copy

accept

getChildren

getChildrenWithTypeReferences

withNewChildren

equals

hashCode

toString

newInputObject

newInputObject