Package graphql.schema.idl

Interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Type Parameters:

T - the type of the object in play

All Known Implementing Classes:

SchemaDirectiveWiringEnvironmentImpl

@PublicApi
public interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

SchemaDirectiveWiring is passed this object as parameters when it builds out behaviour

Method Summary

Modifier and Type	Method	Description
boolean	containsDirective(String directiveName)	Returns true if the named directive is present
GraphQLAppliedDirective	getAppliedDirective()	This returns the applied directive that the SchemaDirectiveWiring was registered against during calls to RuntimeWiring.Builder.directive(String, SchemaDirectiveWiring)
GraphQLAppliedDirective	getAppliedDirective(String directiveName)	Returns a named applied directive or null
Map<String,GraphQLAppliedDirective>	getAppliedDirectives()
Map<String,Object>	getBuildContext()
GraphQLCodeRegistry.Builder	getCodeRegistry()
GraphQLDirective	getDirective()	Deprecated. use getAppliedDirective()
GraphQLDirective	getDirective(String directiveName)	Deprecated. use getAppliedDirective(String) instead
Map<String,GraphQLDirective>	getDirectives()	Deprecated. use getAppliedDirectives() instead
T	getElement()
GraphqlElementParentTree	getElementParentTree()	The type hierarchy depends on the element in question.
DataFetcher<?>	getFieldDataFetcher()	This is useful as a shortcut to get the current fields existing data fetcher
GraphQLFieldDefinition	getFieldDefinition()
GraphQLFieldsContainer	getFieldsContainer()
NodeParentTree<NamedNode<?>>	getNodeParentTree()	The node hierarchy depends on the element in question.
TypeDefinitionRegistry	getRegistry()
GraphQLFieldDefinition	setFieldDataFetcher(DataFetcher<?> newDataFetcher)	This is a shortcut method to set a new data fetcher in the underlying GraphQLCodeRegistry against the current field.

Method Details

getElement

T getElement()

Returns:

the runtime element in play

getDirective

@Deprecated(since="2022-06-21")
GraphQLDirective getDirective()

Deprecated.

use getAppliedDirective()

This returns the directive that the SchemaDirectiveWiring was registered against during calls to RuntimeWiring.Builder.directive(String, SchemaDirectiveWiring)

If this method of registration is not used (say because WiringFactory.providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment) or RuntimeWiring.Builder.directiveWiring(SchemaDirectiveWiring) was used) then this will return null.

Returns:

the directive that was registered under specific directive name or null if it was not registered this way

getAppliedDirective

GraphQLAppliedDirective getAppliedDirective()

This returns the applied directive that the SchemaDirectiveWiring was registered against during calls to RuntimeWiring.Builder.directive(String, SchemaDirectiveWiring)

If this method of registration is not used (say because WiringFactory.providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment) or RuntimeWiring.Builder.directiveWiring(SchemaDirectiveWiring) was used) then this will return null.

Returns:

the applied directive that was registered under specific directive name or null if it was not registered this way

getDirectives

@Deprecated(since="2022-06-21")
Map<String,GraphQLDirective> getDirectives()

Deprecated.

use getAppliedDirectives() instead

Returns:

all of the directives that are on the runtime element

getDirective

@Deprecated(since="2022-06-21")
GraphQLDirective getDirective(String directiveName)

Deprecated.

use getAppliedDirective(String) instead

Returns a named directive or null

Parameters:

directiveName - the name of the directive

Returns:

a named directive or null

getAppliedDirectives

Map<String,GraphQLAppliedDirective> getAppliedDirectives()

Returns:

all of the directives that are on the runtime element

getAppliedDirective

GraphQLAppliedDirective getAppliedDirective(String directiveName)

Returns a named applied directive or null

Parameters:

directiveName - the name of the directive

Returns:

a named directive or null

containsDirective

boolean containsDirective(String directiveName)

Returns true if the named directive is present

Parameters:

directiveName - the name of the directive

Returns:

true if the named directive is present

getNodeParentTree

NodeParentTree<NamedNode<?>> getNodeParentTree()

The node hierarchy depends on the element in question. For example ObjectTypeDefinition nodes have no parent, however a Argument might be on a FieldDefinition which in turn might be on a ObjectTypeDefinition say

Returns:

hierarchical graphql language node information

getElementParentTree

GraphqlElementParentTree getElementParentTree()

The type hierarchy depends on the element in question. For example GraphQLObjectType elements have no parent, however a GraphQLArgument might be on a GraphQLFieldDefinition which in turn might be on a GraphQLObjectType say

Returns:

hierarchical graphql type information

getRegistry

TypeDefinitionRegistry getRegistry()

Returns:

the type registry

getBuildContext

Map<String,Object> getBuildContext()

Returns:

a map that can be used by implementors to hold context during the SDL build process

getCodeRegistry

GraphQLCodeRegistry.Builder getCodeRegistry()

Returns:

a builder of the current code registry builder

getFieldsContainer

GraphQLFieldsContainer getFieldsContainer()

Returns:

a GraphQLFieldsContainer when the element is contained with a fields container

getFieldDefinition

GraphQLFieldDefinition getFieldDefinition()

Returns:

a GraphQLFieldDefinition when the element is as field or is contained within one

getFieldDataFetcher

DataFetcher<?> getFieldDataFetcher()

This is useful as a shortcut to get the current fields existing data fetcher

Returns:

a DataFetcher when the element is as field or is contained within one

Throws:

AssertException - if there is not field in context at the time of the directive wiring callback

setFieldDataFetcher

GraphQLFieldDefinition setFieldDataFetcher(DataFetcher<?> newDataFetcher)

This is a shortcut method to set a new data fetcher in the underlying GraphQLCodeRegistry against the current field.

Often schema directive wiring modify behaviour by wrapping or replacing data fetchers on fields. This method is a helper to make this easier in code.

Parameters:

newDataFetcher - the new data fetcher to use for this field

Returns:

the environments getFieldDefinition() to allow for a more fluent code style

Throws:

AssertException - if there is not field in context at the time of the directive wiring callback