Package graphql.schema.idl

Class SchemaDirectiveWiringEnvironmentImpl<T extends GraphQLDirectiveContainer>

java.lang.Object

graphql.schema.idl.SchemaDirectiveWiringEnvironmentImpl<T>

All Implemented Interfaces:

SchemaDirectiveWiringEnvironment<T>

public class SchemaDirectiveWiringEnvironmentImpl<T extends GraphQLDirectiveContainer>
extends Object
implements SchemaDirectiveWiringEnvironment<T>

Constructor Summary

Constructors

Constructor	Description
SchemaDirectiveWiringEnvironmentImpl(T element, List<GraphQLDirective> directives, List<GraphQLAppliedDirective> appliedDirectives, GraphQLAppliedDirective registeredAppliedDirective, GraphQLDirective registeredDirective, graphql.schema.idl.SchemaGeneratorDirectiveHelper.Parameters parameters)

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()	This returns the directive that the SchemaDirectiveWiring was registered against during calls to RuntimeWiring.Builder.directive(String, SchemaDirectiveWiring)
GraphQLDirective	getDirective(String directiveName)	Returns a named directive or null
Map<String,GraphQLDirective>	getDirectives()
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.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaDirectiveWiringEnvironmentImpl

public SchemaDirectiveWiringEnvironmentImpl(T element,
 List<GraphQLDirective> directives,
 List<GraphQLAppliedDirective> appliedDirectives,
 GraphQLAppliedDirective registeredAppliedDirective,
 GraphQLDirective registeredDirective,
 graphql.schema.idl.SchemaGeneratorDirectiveHelper.Parameters parameters)

Method Details

getElement

public T getElement()

Specified by:

getElement in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

the runtime element in play

getDirective

public GraphQLDirective getDirective()

Description copied from interface: SchemaDirectiveWiringEnvironment

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.

Specified by:

getDirective in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

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

getAppliedDirective

public GraphQLAppliedDirective getAppliedDirective()

Description copied from interface: SchemaDirectiveWiringEnvironment

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.

Specified by:

getAppliedDirective in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

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

getDirectives

public Map<String,GraphQLDirective> getDirectives()

Specified by:

getDirectives in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

all of the directives that are on the runtime element

getDirective

public GraphQLDirective getDirective(String directiveName)

Description copied from interface: SchemaDirectiveWiringEnvironment

Returns a named directive or null

Specified by:

getDirective in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Parameters:

directiveName - the name of the directive

Returns:

a named directive or null

getAppliedDirectives

public Map<String,GraphQLAppliedDirective> getAppliedDirectives()

Specified by:

getAppliedDirectives in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

all of the directives that are on the runtime element

getAppliedDirective

public GraphQLAppliedDirective getAppliedDirective(String directiveName)

Description copied from interface: SchemaDirectiveWiringEnvironment

Returns a named applied directive or null

Specified by:

getAppliedDirective in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Parameters:

directiveName - the name of the directive

Returns:

a named directive or null

containsDirective

public boolean containsDirective(String directiveName)

Description copied from interface: SchemaDirectiveWiringEnvironment

Returns true if the named directive is present

Specified by:

containsDirective in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Parameters:

directiveName - the name of the directive

Returns:

true if the named directive is present

getNodeParentTree

public NodeParentTree<NamedNode<?>> getNodeParentTree()

Description copied from interface: SchemaDirectiveWiringEnvironment

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

Specified by:

getNodeParentTree in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

hierarchical graphql language node information

getRegistry

public TypeDefinitionRegistry getRegistry()

Specified by:

getRegistry in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

the type registry

getBuildContext

public Map<String,Object> getBuildContext()

Specified by:

getBuildContext in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

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

getCodeRegistry

public GraphQLCodeRegistry.Builder getCodeRegistry()

Specified by:

getCodeRegistry in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

a builder of the current code registry builder

getFieldsContainer

public GraphQLFieldsContainer getFieldsContainer()

Specified by:

getFieldsContainer in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

a GraphQLFieldsContainer when the element is contained with a fields container

getElementParentTree

public GraphqlElementParentTree getElementParentTree()

Description copied from interface: SchemaDirectiveWiringEnvironment

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

Specified by:

getElementParentTree in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

hierarchical graphql type information

getFieldDefinition

public GraphQLFieldDefinition getFieldDefinition()

Specified by:

getFieldDefinition in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

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

getFieldDataFetcher

public DataFetcher<?> getFieldDataFetcher()

Description copied from interface: SchemaDirectiveWiringEnvironment

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

Specified by:

getFieldDataFetcher in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Returns:

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

setFieldDataFetcher

public GraphQLFieldDefinition setFieldDataFetcher(DataFetcher<?> newDataFetcher)

Description copied from interface: SchemaDirectiveWiringEnvironment

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.

Specified by:

setFieldDataFetcher in interface SchemaDirectiveWiringEnvironment<T extends GraphQLDirectiveContainer>

Parameters:

newDataFetcher - the new data fetcher to use for this field

Returns:

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