graphql.schema

Class DataFetchingEnvironmentImpl

java.lang.Object

graphql.schema.DataFetchingEnvironmentImpl

All Implemented Interfaces:

DataFetchingEnvironment

public class DataFetchingEnvironmentImpl
extends java.lang.Object
implements DataFetchingEnvironment

Constructor Summary

Constructors

Constructor and Description

DataFetchingEnvironmentImpl(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> arguments, java.lang.Object context, java.lang.Object root, GraphQLFieldDefinition fieldDefinition, java.util.List<Field> fields, GraphQLOutputType fieldType, GraphQLType parentType, GraphQLSchema graphQLSchema, java.util.Map<java.lang.String,FragmentDefinition> fragmentsByName, ExecutionId executionId, DataFetchingFieldSelectionSet selectionSet, ExecutionStepInfo executionStepInfo, ExecutionContext executionContext)

Method Summary

Modifier and Type	Method and Description
boolean	containsArgument(java.lang.String name) Returns true of the named argument is present
<T> T	getArgument(java.lang.String name) Returns the named argument
java.util.Map<java.lang.String,java.lang.Object>	getArguments()
<T> T	getContext() Returns a context argument that is set up when the GraphQL.execute(java.lang.String) method is invoked.
<K,V> org.dataloader.DataLoader<K,V>	getDataLoader(java.lang.String dataLoaderName) This allows you to retrieve a named dataloader from the underlying DataLoaderRegistry
ExecutionContext	getExecutionContext()
ExecutionId	getExecutionId()
ExecutionStepInfo	getExecutionStepInfo()
Field	getField()
GraphQLFieldDefinition	getFieldDefinition()
java.util.List<Field>	getFields() It can happen that a query has overlapping fields which are are querying the same data.
GraphQLOutputType	getFieldType()
java.util.Map<java.lang.String,FragmentDefinition>	getFragmentsByName()
GraphQLSchema	getGraphQLSchema()
GraphQLType	getParentType()
<T> T	getRoot() This is the source object for the root query.
DataFetchingFieldSelectionSet	getSelectionSet()
<T> T	getSource() This is the value of the current object to be queried.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFetchingEnvironmentImpl

public DataFetchingEnvironmentImpl(java.lang.Object source,
                                   java.util.Map<java.lang.String,java.lang.Object> arguments,
                                   java.lang.Object context,
                                   java.lang.Object root,
                                   GraphQLFieldDefinition fieldDefinition,
                                   java.util.List<Field> fields,
                                   GraphQLOutputType fieldType,
                                   GraphQLType parentType,
                                   GraphQLSchema graphQLSchema,
                                   java.util.Map<java.lang.String,FragmentDefinition> fragmentsByName,
                                   ExecutionId executionId,
                                   DataFetchingFieldSelectionSet selectionSet,
                                   ExecutionStepInfo executionStepInfo,
                                   ExecutionContext executionContext)

Method Detail

getSource

public <T> T getSource()

Description copied from interface: DataFetchingEnvironment

This is the value of the current object to be queried. Or to put it differently: it is the value of the parent field.

For the root query, it is equal to {DataFetchingEnvironment.getRoot()

Specified by:

getSource in interface DataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Returns:

can be null for the root query, otherwise it is never null

getArguments

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

Specified by:

getArguments in interface DataFetchingEnvironment

Returns:

the arguments that have been passed in via the graphql query

containsArgument

public boolean containsArgument(java.lang.String name)

Description copied from interface: DataFetchingEnvironment

Returns true of the named argument is present

Specified by:

containsArgument in interface DataFetchingEnvironment

Parameters:

name - the name of the argument

Returns:

true of the named argument is present

getArgument

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

Description copied from interface: DataFetchingEnvironment

Returns the named argument

Specified by:

getArgument in interface DataFetchingEnvironment

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

getContext

public <T> T getContext()

Description copied from interface: DataFetchingEnvironment

Returns a context argument that is set up when the GraphQL.execute(java.lang.String) method is invoked.

This is a info object which is provided to all DataFetcher, but never used by graphql-java itself.

Specified by:

getContext in interface DataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Returns:

can be null

getRoot

public <T> T getRoot()

Description copied from interface: DataFetchingEnvironment

This is the source object for the root query.

Specified by:

getRoot in interface DataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Returns:

can be null

getFieldDefinition

public GraphQLFieldDefinition getFieldDefinition()

Specified by:

getFieldDefinition in interface DataFetchingEnvironment

Returns:

the definition of the current field

getFields

public java.util.List<Field> getFields()

Description copied from interface: DataFetchingEnvironment

It can happen that a query has overlapping fields which are are querying the same data. If this is the case they get merged together and fetched only once, but this method returns all of the Fields from the query. Most of the time you probably want to use DataFetchingEnvironment.getField(). Example query with more than one Field returned:

 

      query Foo {
          bar
          ...BarFragment
      }

      fragment BarFragment on Query {
          bar
      }
 
 

Specified by:

getFields in interface DataFetchingEnvironment

Returns:

the list of fields currently queried

getField

public Field getField()

Specified by:

getField in interface DataFetchingEnvironment

Returns:

returns the field which is currently queried. See also DataFetchingEnvironment.getFields()

getFieldType

public GraphQLOutputType getFieldType()

Specified by:

getFieldType in interface DataFetchingEnvironment

Returns:

graphql type of the current field

getParentType

public GraphQLType getParentType()

Specified by:

getParentType in interface DataFetchingEnvironment

Returns:

the type of the parent of the current field

getGraphQLSchema

public GraphQLSchema getGraphQLSchema()

Specified by:

getGraphQLSchema in interface DataFetchingEnvironment

Returns:

the underlying graphql schema

getFragmentsByName

public java.util.Map<java.lang.String,FragmentDefinition> getFragmentsByName()

Specified by:

getFragmentsByName in interface DataFetchingEnvironment

Returns:

the FragmentDefinition map for the current data fetch operation

getExecutionId

public ExecutionId getExecutionId()

Specified by:

getExecutionId in interface DataFetchingEnvironment

Returns:

the ExecutionId for the current data fetch operation

getSelectionSet

public DataFetchingFieldSelectionSet getSelectionSet()

Specified by:

getSelectionSet in interface DataFetchingEnvironment

Returns:

the DataFetchingFieldSelectionSet for the current data fetch operation

getExecutionStepInfo

public ExecutionStepInfo getExecutionStepInfo()

Specified by:

getExecutionStepInfo in interface DataFetchingEnvironment

Returns:

the field ExecutionStepInfo for the current data fetch operation

getExecutionContext

public ExecutionContext getExecutionContext()

Specified by:

getExecutionContext in interface DataFetchingEnvironment

Returns:

the current ExecutionContext. It gives access to the overall schema and other things related to the overall execution of the current request.

getDataLoader

public <K,V> org.dataloader.DataLoader<K,V> getDataLoader(java.lang.String dataLoaderName)

Description copied from interface: DataFetchingEnvironment

This allows you to retrieve a named dataloader from the underlying DataLoaderRegistry

Specified by:

getDataLoader in interface DataFetchingEnvironment

Type Parameters:

K - the key type

V - the value type

Parameters:

dataLoaderName - the name of the data loader to fetch

Returns:

the named data loader or null

See Also:

ExecutionContext.getDataLoaderRegistry(), DataLoaderRegistry.getDataLoader(String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object