Package graphql.schema

Class DelegatingDataFetchingEnvironment

java.lang.Object

graphql.schema.DelegatingDataFetchingEnvironment

All Implemented Interfaces:

IntrospectionDataFetchingEnvironment, DataFetchingEnvironment

@PublicApi
public class DelegatingDataFetchingEnvironment
extends Object
implements DataFetchingEnvironment

DelegatingDataFetchingEnvironment implements DataFetchingEnvironment by delegating to an underlying instance. You can use this class to wrap the environment and perhaps change values and behavior more easily.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DataFetchingEnvironment	delegateEnvironment

Constructor Summary

Constructors

Constructor	Description
DelegatingDataFetchingEnvironment(DataFetchingEnvironment delegateEnvironment)	Called to wrap an existing DataFetchingEnvironment.

Method Summary

Modifier and Type	Method	Description
boolean	containsArgument(String name)	Returns true of the named argument is present
<T> T	getArgument(String name)	Returns the named argument
<T> T	getArgumentOrDefault(String name, T defaultValue)	Returns the named argument or the default value
Map<String,Object>	getArguments()
<T> T	getContext()	Deprecated.
<K, V> @Nullable org.dataloader.DataLoader<K,V>	getDataLoader(String dataLoaderName)	This allows you to retrieve a named dataloader from the underlying DataLoaderRegistry
org.dataloader.DataLoaderRegistry	getDataLoaderRegistry()
Document	getDocument()
ExecutionId	getExecutionId()
ExecutionStepInfo	getExecutionStepInfo()
Field	getField()
GraphQLFieldDefinition	getFieldDefinition()
List<Field>	getFields()	Deprecated.
GraphQLOutputType	getFieldType()
Map<String,FragmentDefinition>	getFragmentsByName()
@NonNull GraphQLContext	getGraphQlContext()	Returns a shared context argument that is set up when the GraphQL.execute(graphql.ExecutionInput) )} method is invoked.
GraphQLSchema	getGraphQLSchema()
<T> @Nullable T	getLocalContext()	This returns a context object that parent fields may have returned via DataFetcherResult.getLocalContext() which can be used to pass down extra information to fields beyond the normal DataFetchingEnvironment.getSource()
Locale	getLocale()
MergedField	getMergedField()	It can happen that a query has overlapping fields which are querying the same data.
OperationDefinition	getOperationDefinition()
GraphQLType	getParentType()
QueryDirectives	getQueryDirectives()	This gives you access to the directives related to this field
<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.
Map<String,Object>	getVariables()	This returns the variables that have been passed into the query.
Object	toInternal()	A method that should only be used by the GraphQL Java library itself.

Methods inherited from class java.lang.Object

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

Field Details

delegateEnvironment

protected final DataFetchingEnvironment delegateEnvironment

Constructor Details

DelegatingDataFetchingEnvironment

public DelegatingDataFetchingEnvironment(DataFetchingEnvironment delegateEnvironment)

Called to wrap an existing DataFetchingEnvironment.

Parameters:

delegateEnvironment - the environment to wrap and delegate all method called to

Method Details

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

Specified by:

getSource in interface IntrospectionDataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Returns:

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

getArguments

public Map<String,Object> getArguments()

Specified by:

getArguments in interface DataFetchingEnvironment

Specified by:

getArguments in interface IntrospectionDataFetchingEnvironment

Returns:

the arguments that have been passed in via the graphql query

containsArgument

public boolean containsArgument(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(String name)

Description copied from interface: DataFetchingEnvironment

Returns the named argument

Specified by:

getArgument in interface DataFetchingEnvironment

Specified by:

getArgument in interface IntrospectionDataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Parameters:

name - the name of the argument

Returns:

the named argument or null if it's not present

getArgumentOrDefault

public <T> T getArgumentOrDefault(String name,
 T defaultValue)

Description copied from interface: DataFetchingEnvironment

Returns the named argument or the default value

Specified by:

getArgumentOrDefault in interface DataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Parameters:

name - the name of the argument

defaultValue - the default value if the argument is not present

Returns:

the named argument or the default if it's not present

getContext

@Deprecated(since="2022-04-17")
public <T> T getContext()

Deprecated.

Description copied from interface: DataFetchingEnvironment

Returns a legacy context argument that is set up when the GraphQL.execute(graphql.ExecutionInput) method is invoked.

This is an info object which is provided to all DataFetchers, 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

getGraphQlContext

public @NonNull GraphQLContext getGraphQlContext()

Description copied from interface: DataFetchingEnvironment

Returns a shared context argument that is set up when the GraphQL.execute(graphql.ExecutionInput) )} method is invoked.

This is an info object which is provided to all DataFetchers.

Specified by:

getGraphQlContext in interface DataFetchingEnvironment

Returns:

can NOT be null

getLocalContext

public <T> @Nullable T getLocalContext()

Description copied from interface: DataFetchingEnvironment

This returns a context object that parent fields may have returned via DataFetcherResult.getLocalContext() which can be used to pass down extra information to fields beyond the normal DataFetchingEnvironment.getSource()

This differs from DataFetchingEnvironment.getGraphQlContext() in that it's field specific and passed from parent field to child field, whilst DataFetchingEnvironment.getGraphQlContext() is global for the whole query.

If the field is a top level field then 'localContext' equals null since it's never be set until those fields execute.

Specified by:

getLocalContext in interface DataFetchingEnvironment

Type Parameters:

T - you decide what type it is

Returns:

can be null if no field context objects are passed back by previous parent fields

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

@Deprecated(since="2019-10-07")
public List<Field> getFields()

Deprecated.

Specified by:

getFields in interface DataFetchingEnvironment

Returns:

the list of fields

getMergedField

public MergedField getMergedField()

Description copied from interface: DataFetchingEnvironment

It can happen that a query has overlapping fields which 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:

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

getFieldType

public GraphQLOutputType getFieldType()

Specified by:

getFieldType in interface DataFetchingEnvironment

Returns:

graphql type of the current field

getExecutionStepInfo

public ExecutionStepInfo getExecutionStepInfo()

Specified by:

getExecutionStepInfo in interface DataFetchingEnvironment

Returns:

the field ExecutionStepInfo for the current data fetch operation

getParentType

public GraphQLType getParentType()

Specified by:

getParentType in interface DataFetchingEnvironment

Specified by:

getParentType in interface IntrospectionDataFetchingEnvironment

Returns:

the type of the parent of the current field

getGraphQLSchema

public GraphQLSchema getGraphQLSchema()

Specified by:

getGraphQLSchema in interface DataFetchingEnvironment

Specified by:

getGraphQLSchema in interface IntrospectionDataFetchingEnvironment

Returns:

the underlying graphql schema

getFragmentsByName

public Map<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

getQueryDirectives

public QueryDirectives getQueryDirectives()

Description copied from interface: DataFetchingEnvironment

This gives you access to the directives related to this field

Specified by:

getQueryDirectives in interface DataFetchingEnvironment

Returns:

the QueryDirectives for the currently executing field

See Also:

• for more information

getDataLoader

public <K,
V>
@Nullable org.dataloader.DataLoader<K,V> getDataLoader(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:

• DataLoaderRegistry.getDataLoader(String)

getDataLoaderRegistry

public org.dataloader.DataLoaderRegistry getDataLoaderRegistry()

Specified by:

getDataLoaderRegistry in interface DataFetchingEnvironment

Returns:

the DataLoaderRegistry in play

getLocale

public Locale getLocale()

Specified by:

getLocale in interface DataFetchingEnvironment

Returns:

the current Locale instance used for this request

getOperationDefinition

public OperationDefinition getOperationDefinition()

Specified by:

getOperationDefinition in interface DataFetchingEnvironment

Returns:

the current operation that is being executed

getDocument

public Document getDocument()

Specified by:

getDocument in interface DataFetchingEnvironment

Returns:

the current query Document that is being executed

getVariables

public Map<String,Object> getVariables()

Description copied from interface: DataFetchingEnvironment

This returns the variables that have been passed into the query. Note that this is the query variables themselves and not the arguments to the field, which is accessed via DataFetchingEnvironment.getArguments()

The field arguments are created by interpolating any referenced variables and AST literals and resolving them into the arguments.

Also note that the raw query variables are "coerced" into a map where the leaf scalar and enum types are called to create input coerced values. So the values you get here are not exactly as passed via ExecutionInput.getVariables() but have been processed.

Specified by:

getVariables in interface DataFetchingEnvironment

Returns:

the coerced variables that have been passed to the query that is being executed

toInternal

public Object toInternal()

Description copied from interface: DataFetchingEnvironment

A method that should only be used by the GraphQL Java library itself. It is not intended for public use.

Specified by:

toInternal in interface DataFetchingEnvironment

Returns:

an internal representation of the DataFetchingEnvironment