graphql.execution.DataFetcherResult 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.execution;

import graphql.GraphQLError;
import graphql.Internal;
import graphql.PublicApi;
import graphql.schema.DataFetcher;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;

import static graphql.Assert.assertNotNull;
import static java.util.Collections.unmodifiableList;


/**
 * An object that can be returned from a {@link DataFetcher} that contains both data, local context and errors to be relativized and
 * added to the final result. This is a useful when your ``DataFetcher`` retrieves data from multiple sources
 * or from another GraphQL resource or you want to pass extra context to lower levels.
 *
 * This also allows you to pass down new local context objects between parent and child fields.  If you return a
 * {@link #getLocalContext()} value then it will be passed down into any child fields via
 * {@link graphql.schema.DataFetchingEnvironment#getLocalContext()}
 *
 * @param  The type of the data fetched
 */
@PublicApi
public class DataFetcherResult {

    private final T data;
    private final List errors;
    private final Object localContext;
    private final boolean mapRelativeErrors;

    /**
     * Creates a data fetcher result
     *
     * @param data   the data
     * @param errors the errors
     *
     * @deprecated use the {@link #newResult()} builder instead
     */
    @Internal
    @Deprecated
    public DataFetcherResult(T data, List errors) {
        this(data, errors, null, false);
    }

    private DataFetcherResult(T data, List errors, Object localContext, boolean mapRelativeErrors) {
        this.data = data;
        this.errors = unmodifiableList(assertNotNull(errors));
        this.localContext = localContext;
        this.mapRelativeErrors = mapRelativeErrors;
    }

    /**
     * @return The data fetched. May be null.
     */
    public T getData() {
        return data;
    }

    /**
     * @return errors encountered when fetching data.  This will be non null but possibly empty.
     */
    public List getErrors() {
        return errors;
    }

    /**
     * @return true if there are any errors present
     */
    public boolean hasErrors() {
        return !errors.isEmpty();
    }

    /**
     * A data fetcher result can supply a context object for that field that is passed down to child fields
     *
     * @return a local context object
     */
    public Object getLocalContext() {
        return localContext;
    }

    /**
     * When this returns true, the data fetching code will map this error as being a relative error from the existing field.
     * 
     * This is useful when you are calling a down stream graphql system and you want to make the errors appear to be from a point
     * relative to the currently executing field.
     * 
     * By default this behavior is off
     *
     * @return true if relative error mapping should occur.
     */
    public boolean isMapRelativeErrors() {
        return mapRelativeErrors;
    }

    /**
     * This helps you transform the current DataFetcherResult into another one by starting a builder with all
     * the current values and allows you to transform it how you want.
     *
     * @param builderConsumer the consumer code that will be given a builder to transform
     *
     * @return a new instance produced by calling {@code build} on that builder
     */
    public DataFetcherResult transform(Consumer> builderConsumer) {
        Builder builder = new Builder<>(this);
        builderConsumer.accept(builder);
        return builder.build();
    }

    /**
     * Creates a new data fetcher result builder
     *
     * @param  the type of the result
     *
     * @return a new builder
     */
    public static  Builder newResult() {
        return new Builder<>();
    }

    public static class Builder {
        private T data;
        private Object localContext;
        private final List errors = new ArrayList<>();
        private boolean mapRelativeErrors = false;

        public Builder(DataFetcherResult existing) {
            data = existing.getData();
            localContext = existing.getLocalContext();
            errors.addAll(existing.getErrors());
            mapRelativeErrors = existing.isMapRelativeErrors();
        }

        public Builder(T data) {
            this.data = data;
        }

        public Builder() {
        }

        public Builder data(T data) {
            this.data = data;
            return this;
        }

        public Builder errors(List errors) {
            this.errors.addAll(errors);
            return this;
        }

        public Builder error(GraphQLError error) {
            this.errors.add(error);
            return this;
        }

        public Builder mapRelativeErrors(boolean mapRelativeErrors) {
            this.mapRelativeErrors = mapRelativeErrors;
            return this;
        }

        /**
         * @return true if there are any errors present
         */
        public boolean hasErrors() {
            return !errors.isEmpty();
        }

        public Builder localContext(Object localContext) {
            this.localContext = localContext;
            return this;
        }

        public DataFetcherResult build() {
            return new DataFetcherResult<>(data, errors, localContext, mapRelativeErrors);
        }
    }
}