graphql.schema.idl.WiringFactory Maven / Gradle / Ivy
package graphql.schema.idl;
import graphql.PublicSpi;
import graphql.schema.DataFetcher;
import graphql.schema.DataFetcherFactory;
import graphql.schema.GraphQLScalarType;
import graphql.schema.TypeResolver;
import static graphql.Assert.assertShouldNeverHappen;
/**
* A WiringFactory allows you to more dynamically wire in {@link TypeResolver}s and {@link DataFetcher}s
* based on the IDL definitions. For example you could look at the directives say to build a more dynamic
* set of type resolvers and data fetchers.
*/
@PublicSpi
public interface WiringFactory {
/**
* This is called to ask if this factory can provide a custom scalar
*
* @param environment the wiring environment
*
* @return true if the factory can give out a type resolver
*/
default boolean providesScalar(ScalarWiringEnvironment environment) {
return false;
}
/**
* Returns a {@link GraphQLScalarType} given scalar defined in IDL
*
* @param environment the wiring environment
*
* @return a {@link GraphQLScalarType}
*/
default GraphQLScalarType getScalar(ScalarWiringEnvironment environment) {
return assertShouldNeverHappen();
}
/**
* This is called to ask if this factory can provide a type resolver for the interface
*
* @param environment the wiring environment
*
* @return true if the factory can give out a type resolver
*/
default boolean providesTypeResolver(InterfaceWiringEnvironment environment) {
return false;
}
/**
* Returns a {@link TypeResolver} given the type interface
*
* @param environment the wiring environment
*
* @return a {@link TypeResolver}
*/
default TypeResolver getTypeResolver(InterfaceWiringEnvironment environment) {
return assertShouldNeverHappen();
}
/**
* This is called to ask if this factory can provide a type resolver for the union
*
* @param environment the wiring environment
*
* @return true if the factory can give out a type resolver
*/
default boolean providesTypeResolver(UnionWiringEnvironment environment) {
return false;
}
/**
* Returns a {@link TypeResolver} given the type union
*
* @param environment the union wiring environment
*
* @return a {@link TypeResolver}
*/
default TypeResolver getTypeResolver(UnionWiringEnvironment environment) {
return assertShouldNeverHappen();
}
/**
* This is called to ask if this factory can provide a {@link graphql.schema.DataFetcherFactory} for the definition
*
* @param environment the wiring environment
*
* @return true if the factory can give out a data fetcher factory
*/
default boolean providesDataFetcherFactory(FieldWiringEnvironment environment) {
return false;
}
/**
* Returns a {@link graphql.schema.DataFetcherFactory} given the type definition
*
* @param environment the wiring environment
* @param the type of the data fetcher
*
* @return a {@link graphql.schema.DataFetcherFactory}
*/
default DataFetcherFactory getDataFetcherFactory(FieldWiringEnvironment environment) {
return assertShouldNeverHappen();
}
/**
* This is called to ask if this factory can provide a schema directive wiring.
*
* {@link SchemaDirectiveWiringEnvironment#getDirectives()} contains all the directives
* available which may in fact be an empty list.
*
* @param environment the calling environment
*
* @return true if the factory can give out a schema directive wiring.
*/
default boolean providesSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment environment) {
return false;
}
/**
* Returns a {@link graphql.schema.idl.SchemaDirectiveWiring} given the environment
*
* @param environment the calling environment
*
* @return a {@link graphql.schema.idl.SchemaDirectiveWiring}
*/
default SchemaDirectiveWiring getSchemaDirectiveWiring(SchemaDirectiveWiringEnvironment environment) {
return assertShouldNeverHappen();
}
/**
* This is called to ask if this factory can provide a data fetcher for the definition
*
* @param environment the wiring environment
*
* @return true if the factory can give out a data fetcher
*/
default boolean providesDataFetcher(FieldWiringEnvironment environment) {
return false;
}
/**
* Returns a {@link DataFetcher} given the type definition
*
* @param environment the wiring environment
*
* @return a {@link DataFetcher}
*/
default DataFetcher getDataFetcher(FieldWiringEnvironment environment) {
return assertShouldNeverHappen();
}
/**
* All fields need a data fetcher of some sort and this method is called to provide the data fetcher
* that will be used if no specific one has been provided
*
* @param environment the wiring environment
*
* @return a {@link DataFetcher}
*/
default DataFetcher getDefaultDataFetcher(FieldWiringEnvironment environment) {
return null;
}
}