GraphQLInputObjectField (graphql-java 17.0 API)

java.lang.Object
- graphql.schema.GraphQLInputObjectField

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputValueDefinition, GraphQLNamedSchemaElement, GraphQLSchemaElement
```
@PublicApi
public class GraphQLInputObjectField
extends java.lang.Object
implements GraphQLNamedSchemaElement, GraphQLInputValueDefinition
```
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

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

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CHILD_DIRECTIVES

static java.lang.String CHILD_TYPE

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

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()`
`InputValueDefinition`	`getDefinition()` The AST `Node` this schema element is based on.
`java.lang.String`	`getDeprecationReason()`
`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`.
`@NotNull InputValueWithState`	`getInputFieldDefaultValue()` The default value of this input field.
`static <T> T`	`getInputFieldDefaultValue(GraphQLInputObjectField inputObjectField)` This static helper method will give out a java value based on the semantics captured in the `InputValueWithState` from `getInputFieldDefaultValue()` Note : You MUST only call this on a `GraphQLInputObjectField` that is part of a fully formed schema.
`java.lang.String`	`getName()`
`GraphQLInputType`	`getType()`
`int`	`hashCode()` No GraphQLSchemaElement implements `equals/hashCode` because we need object identity to treat a GraphQLSchema as an abstract graph.
`boolean`	`hasSetDefaultValue()`
`boolean`	`isDeprecated()`
`static GraphQLInputObjectField.Builder`	`newInputObjectField()`
`static GraphQLInputObjectField.Builder`	`newInputObjectField(GraphQLInputObjectField existing)`
`java.lang.String`	`toString()`
`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.
`GraphQLInputObjectField`	`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_TYPE
```
public static final java.lang.String CHILD_TYPE
```
    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
  - getType
```
public GraphQLInputType getType()
```
    Specified by:
    
    getType in interface GraphQLInputValueDefinition
  - getInputFieldDefaultValue
```
@NotNull
public @NotNull InputValueWithState getInputFieldDefaultValue()
```
    The default value of this input field. The semantics of the returned Object depend on how the InputValueWithState was created.
    
    Returns:
    
    a input value with captured state
  - getInputFieldDefaultValue
```
public static <T> T getInputFieldDefaultValue(GraphQLInputObjectField inputObjectField)
```
    This static helper method will give out a java value based on the semantics captured in the InputValueWithState from getInputFieldDefaultValue() Note : You MUST only call this on a GraphQLInputObjectField that is part of a fully formed schema. We need all of the types to be resolved in order for this work correctly. Note: This method will return null if the value is not set or explicitly set to null. If you you to know the difference when "not set" and "set to null" then you cant use this method. Rather you should use getInputFieldDefaultValue() and use the InputValueWithState.isNotSet() methods to decide how to handle those values.
    
    Type Parameters:
    
    T - the type you want it cast as
    
    Parameters:
    
    inputObjectField - the fully formed GraphQLInputObjectField
    
    Returns:
    
    a value of type T which is the java value of the input field default
  - hasSetDefaultValue
```
public boolean hasSetDefaultValue()
```
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface GraphQLNamedSchemaElement
  - getDeprecationReason
```
public java.lang.String getDeprecationReason()
```
  - isDeprecated
```
public boolean isDeprecated()
```
  - getDefinition
```
public InputValueDefinition 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.
  - 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
  - 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
  - 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 GraphQLInputObjectField 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
  - newInputObjectField
```
public static GraphQLInputObjectField.Builder newInputObjectField(GraphQLInputObjectField existing)
```
  - newInputObjectField
```
public static GraphQLInputObjectField.Builder newInputObjectField()
```

Class GraphQLInputObjectField

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

Field Detail

CHILD_TYPE

CHILD_DIRECTIVES

Method Detail

getName

getType

getInputFieldDefaultValue

getInputFieldDefaultValue

hasSetDefaultValue

getDescription

getDeprecationReason

isDeprecated

getDefinition

getDirectives

getDirectivesByName

getAllDirectivesByName

getDirective

transform

copy

accept

getChildren

getChildrenWithTypeReferences

withNewChildren

equals

hashCode

toString

newInputObjectField

newInputObjectField