graphql.schema

Class GraphQLArgument

java.lang.Object

graphql.schema.GraphQLArgument

All Implemented Interfaces:

GraphQLDirectiveContainer, GraphQLInputValueDefinition, GraphQLNamedSchemaElement, GraphQLSchemaElement

@PublicApi
public class GraphQLArgument
extends java.lang.Object
implements GraphQLNamedSchemaElement, GraphQLInputValueDefinition

This defines an argument that can be supplied to a graphql field (via GraphQLFieldDefinition. Fields can be thought of as "functions" that take arguments and return a value. See http://graphql.org/learn/queries/#arguments for more details on the concept. GraphQLArgument is used in two contexts, one context is graphql queries where it represents the arguments that can be set on a field and the other is in Schema Definition Language (SDL) where it can be used to represent the argument value instances that have been supplied on a GraphQLDirective. The difference is the 'value' and 'defaultValue' properties. In a query argument, the 'value' is never in the GraphQLArgument object but rather in the AST direct or in the query variables map and the 'defaultValue' represents a value to use if both of these are not present. You can think of them like a descriptor of what shape an argument might have. However with directives on SDL elements, the value is specified in AST only and transferred into the GraphQLArgument object and the 'defaultValue' comes instead from the directive definition elsewhere in the SDL. You can think of them as 'instances' of arguments, their shape and their specific value on that directive.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLArgument.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
GraphQLArgument(java.lang.String name, GraphQLInputType type) Deprecated. use the newArgument() builder pattern instead, as this constructor will be made private in a future version.
GraphQLArgument(java.lang.String name, java.lang.String description, GraphQLInputType type, java.lang.Object defaultValue) Deprecated. use the newArgument() builder pattern instead, as this constructor will be made private in a future version.
GraphQLArgument(java.lang.String name, java.lang.String description, GraphQLInputType type, java.lang.Object defaultValue, InputValueDefinition definition) Deprecated. use the newArgument() 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)
java.util.List<GraphQLSchemaElement>	getChildren()
SchemaElementChildrenContainer	getChildrenWithTypeReferences()
java.lang.Object	getDefaultValue() An argument has a default value when it represents the logical argument structure that a GraphQLFieldDefinition can have and it can also have a default value when used in a schema definition language (SDL) where the default value comes via the directive definition.
InputValueDefinition	getDefinition() The AST Node this schema element is based on.
java.lang.String	getDescription()
java.util.List<GraphQLDirective>	getDirectives()
java.lang.String	getName()
GraphQLInputType	getType()
java.lang.Object	getValue() An argument ONLY has a value when its used in a schema definition language (SDL) context as the arguments to SDL directives.
static GraphQLArgument.Builder	newArgument()
static GraphQLArgument.Builder	newArgument(GraphQLArgument existing)
java.lang.String	toString()
GraphQLArgument	transform(java.util.function.Consumer<GraphQLArgument.Builder> builderConsumer) This helps you transform the current GraphQLArgument into another one by starting a builder with all the current values and allows you to transform it how you want.
GraphQLArgument	withNewChildren(SchemaElementChildrenContainer newChildren)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface graphql.schema.GraphQLDirectiveContainer

getDirective, getDirectivesByName

Field Detail

CHILD_DIRECTIVES

public static final java.lang.String CHILD_DIRECTIVES

See Also:

Constant Field Values

CHILD_TYPE

public static final java.lang.String CHILD_TYPE

See Also:

Constant Field Values

Constructor Detail

GraphQLArgument

@Deprecated
public GraphQLArgument(java.lang.String name,
                                   java.lang.String description,
                                   GraphQLInputType type,
                                   java.lang.Object defaultValue)

Deprecated. use the newArgument() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the arg name

description - the arg description

type - the arg type

defaultValue - the default value

GraphQLArgument

@Deprecated
public GraphQLArgument(java.lang.String name,
                                   GraphQLInputType type)

Deprecated. use the newArgument() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the arg name

type - the arg type

GraphQLArgument

public GraphQLArgument(java.lang.String name,
                       java.lang.String description,
                       GraphQLInputType type,
                       java.lang.Object defaultValue,
                       InputValueDefinition definition)

Deprecated. use the newArgument() builder pattern instead, as this constructor will be made private in a future version.

Parameters:

name - the arg name

description - the arg description

type - the arg type

defaultValue - the default value

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

An argument has a default value when it represents the logical argument structure that a GraphQLFieldDefinition can have and it can also have a default value when used in a schema definition language (SDL) where the default value comes via the directive definition.

Returns:

the default value of an argument

getValue

public java.lang.Object getValue()

An argument ONLY has a value when its used in a schema definition language (SDL) context as the arguments to SDL directives. The method should not be called in a query context, but rather the AST / variables map should be used to obtain an arguments value.

Returns:

the argument value

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

Specified by:

getDirectives in interface GraphQLDirectiveContainer

Returns:

a list of directives associated with the type or field

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 GraphQLArgument withNewChildren(SchemaElementChildrenContainer newChildren)

Specified by:

withNewChildren in interface GraphQLSchemaElement

transform

public GraphQLArgument transform(java.util.function.Consumer<GraphQLArgument.Builder> builderConsumer)

This helps you transform the current GraphQLArgument 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 field based on calling build on that builder

newArgument

public static GraphQLArgument.Builder newArgument()

newArgument

public static GraphQLArgument.Builder newArgument(GraphQLArgument existing)

accept

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

Specified by:

accept in interface GraphQLSchemaElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object