graphql.schema

Class GraphQLInputObjectField

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

Field Summary

Fields

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

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<GraphQLSchemaElement> context, GraphQLTypeVisitor visitor)
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()
java.lang.Object	getDefaultValue()
InputValueDefinition	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.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.
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

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

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 GraphQLNamedSchemaElement

getType

public GraphQLInputType getType()

Specified by:

getType in interface GraphQLInputValueDefinition

getDefaultValue

public java.lang.Object getDefaultValue()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface GraphQLNamedSchemaElement

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

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()