graphql.execution

Class ExecutionInfo

java.lang.Object

graphql.execution.ExecutionInfo

@PublicApi
public class ExecutionInfo
extends java.lang.Object

As the graphql query executes, it forms a hierarchy from parent fields (and their type) to their child fields (and their type) until a scalar type is encountered; this class captures that execution type information.

The static graphql type system (rightly) does not contain a hierarchy of child to parent types nor the nonnull ness of type instances, so this helper class adds this information during query execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutionInfo.Builder

Method Summary

Modifier and Type	Method and Description
<T extends GraphQLType> T	castType(java.lang.Class<T> clazz) This will cast the type to a specific graphql type such as GraphQLObjectType say
<T> T	getArgument(java.lang.String name) Returns the named argument
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
Field	getField() This returns the AST field that matches the getFieldDefinition() during execution
GraphQLFieldDefinition	getFieldDefinition() This returns the field definition that is in play when this type info was created or null if the type is a root query type
ExecutionInfo	getParent()
ExecutionPath	getPath()
GraphQLType	getType() This returns the type which is unwrapped if it was GraphQLNonNull wrapped
boolean	hasParent()
boolean	isListType()
boolean	isNonNullType()
static ExecutionInfo.Builder	newExecutionInfo()
java.lang.String	toAst()
java.lang.String	toString()
ExecutionInfo	treatAs(GraphQLType newType) This allows you to morph a type into a more specialized form yet return the same parent and non-null ness, for example taking a GraphQLInterfaceType and turning it into a specific GraphQLObjectType after type resolution has occurred
static GraphQLType	unwrapBaseType(GraphQLType type) graphql types can be wrapped in GraphQLNonNull and GraphQLList type wrappers so this method will unwrap the type down to the raw underlying type.
static java.util.Stack<GraphQLType>	unwrapType(GraphQLType type) graphql types can be wrapped in GraphQLNonNull and GraphQLList type wrappers so this method will unwrap the type down to the raw unwrapped type and return that wrapping as a stack, with the top of the stack being the raw underling type.

Methods inherited from class java.lang.Object

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

Method Detail

getType

public GraphQLType getType()

This returns the type which is unwrapped if it was GraphQLNonNull wrapped

Returns:

the graphql type in question

getFieldDefinition

public GraphQLFieldDefinition getFieldDefinition()

This returns the field definition that is in play when this type info was created or null if the type is a root query type

Returns:

the field definition or null if there is not one

getField

public Field getField()

This returns the AST field that matches the getFieldDefinition() during execution

Returns:

the field

getPath

public ExecutionPath getPath()

Returns:

the ExecutionPath to this info

castType

public <T extends GraphQLType> T castType(java.lang.Class<T> clazz)

This will cast the type to a specific graphql type such as GraphQLObjectType say

Type Parameters:

T - the type you want to become

Parameters:

clazz - the class to cast to

Returns:

this type cast as that

isNonNullType

public boolean isNonNullType()

Returns:

true if the type must be nonnull

isListType

public boolean isListType()

Returns:

true if the type is a list

getArguments

public java.util.Map<java.lang.String,java.lang.Object> getArguments()

Returns:

the resolved arguments that have been passed to this field

getArgument

public <T> T getArgument(java.lang.String name)

Returns the named argument

Type Parameters:

T - you decide what type it is

Parameters:

name - the name of the argument

Returns:

the named argument or null if its not present

getParent

public ExecutionInfo getParent()

Returns:

the parent type information

hasParent

public boolean hasParent()

Returns:

true if the type has a parent (most do)

treatAs

public ExecutionInfo treatAs(GraphQLType newType)

This allows you to morph a type into a more specialized form yet return the same parent and non-null ness, for example taking a GraphQLInterfaceType and turning it into a specific GraphQLObjectType after type resolution has occurred

Parameters:

newType - the new type to be

Returns:

a new type info with the same

unwrapType

public static java.util.Stack<GraphQLType> unwrapType(GraphQLType type)

graphql types can be wrapped in GraphQLNonNull and GraphQLList type wrappers so this method will unwrap the type down to the raw unwrapped type and return that wrapping as a stack, with the top of the stack being the raw underling type.

Parameters:

type - the type to unwrap

Returns:

a stack of the type wrapping which will be at least 1 later deep

unwrapBaseType

public static GraphQLType unwrapBaseType(GraphQLType type)

graphql types can be wrapped in GraphQLNonNull and GraphQLList type wrappers so this method will unwrap the type down to the raw underlying type.

Parameters:

type - the type to unwrap

Returns:

the underlying raw type with GraphQLNonNull and GraphQLList type wrappers removed

toAst

public java.lang.String toAst()

Returns:

the type in graphql AST format, eg [typeName!]!

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newExecutionInfo

public static ExecutionInfo.Builder newExecutionInfo()

Returns:

a builder of type info