@PublicApi public class GraphQLInputObjectField extends java.lang.Object implements GraphQLDirectiveContainer
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.Modifier and Type | Class and Description |
---|---|
static class |
GraphQLInputObjectField.Builder |
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. |
Modifier and Type | Method and Description |
---|---|
TraversalControl |
accept(TraverserContext<GraphQLType> context,
GraphQLTypeVisitor visitor)
Double-dispatch entry point.
|
java.util.List<GraphQLType> |
getChildren() |
java.lang.Object |
getDefaultValue() |
InputValueDefinition |
getDefinition() |
java.lang.String |
getDescription() |
java.util.List<GraphQLDirective> |
getDirectives() |
java.lang.String |
getName() |
GraphQLInputType |
getType() |
static GraphQLInputObjectField.Builder |
newInputObjectField() |
static GraphQLInputObjectField.Builder |
newInputObjectField(GraphQLInputObjectField existing) |
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDirective, getDirectivesByName
@Deprecated public GraphQLInputObjectField(java.lang.String name, GraphQLInputType type)
newInputObjectField()
builder pattern instead, as this constructor will be made private in a future version.name
- the nametype
- the field type@Deprecated public GraphQLInputObjectField(java.lang.String name, java.lang.String description, GraphQLInputType type, java.lang.Object defaultValue)
newInputObjectField()
builder pattern instead, as this constructor will be made private in a future version.name
- the namedescription
- the descriptiontype
- the field typedefaultValue
- the default value@Deprecated public GraphQLInputObjectField(java.lang.String name, java.lang.String description, GraphQLInputType type, java.lang.Object defaultValue, java.util.List<GraphQLDirective> directives, InputValueDefinition definition)
newInputObjectField()
builder pattern instead, as this constructor will be made private in a future version.name
- the namedescription
- the descriptiontype
- the field typedefaultValue
- the default valuedirectives
- the directives on this type elementdefinition
- the AST definitionpublic java.lang.String getName()
getName
in interface GraphQLType
[_A-Za-z][_0-9A-Za-z]*
public GraphQLInputType getType()
public java.lang.Object getDefaultValue()
public java.lang.String getDescription()
public InputValueDefinition getDefinition()
public java.util.List<GraphQLDirective> getDirectives()
getDirectives
in interface GraphQLDirectiveContainer
public GraphQLInputObjectField transform(java.util.function.Consumer<GraphQLInputObjectField.Builder> builderConsumer)
builderConsumer
- the consumer code that will be given a builder to transformpublic TraversalControl accept(TraverserContext<GraphQLType> context, GraphQLTypeVisitor visitor)
GraphQLType
Node
, see accept(...) for more details about the pattern.accept
in interface GraphQLType
context
- TraverserContext bound to this graphQL type objectvisitor
- Visitor instance that performs actual processing on the types(s)public java.util.List<GraphQLType> getChildren()
getChildren
in interface GraphQLType
public static GraphQLInputObjectField.Builder newInputObjectField(GraphQLInputObjectField existing)
public static GraphQLInputObjectField.Builder newInputObjectField()