graphql.schema.DataFetcherFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphql-java Show documentation

GraphqL Java

There is a newer version: 230521-nf-execution

package graphql.schema;

import graphql.PublicSpi;

/**
 * A DataFetcherFactory allows a level of indirection in providing {@link graphql.schema.DataFetcher}s for graphql fields.
 *
 * For example if you are using an IoC container such as Spring or Guice, you can use this indirection to give you
 * per request late binding of a data fetcher with its dependencies injected in.
 *
 * @param  the type of DataFetcher
 */
@PublicSpi
public interface DataFetcherFactory {

    /**
     * Returns a {@link graphql.schema.DataFetcher}
     *
     * @param environment the environment that needs the data fetcher
     *
     * @return a data fetcher
     *
     * @deprecated This method will go away at some point and {@link DataFetcherFactory#get(GraphQLFieldDefinition)} will be used
     */
    @Deprecated(since = "2024-11-26")
    DataFetcher get(DataFetcherFactoryEnvironment environment);

    /**
     * Returns a {@link graphql.schema.DataFetcher} given the field definition
     * which is cheaper in object allocation terms.
     *
     * @param fieldDefinition the field that needs the data fetcher
     *
     * @return a data fetcher
     */

    default DataFetcher get(GraphQLFieldDefinition fieldDefinition) {
        return null;
    }

}