graphql.execution.TypeResolutionParameters 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.GraphQLContext;
import graphql.Internal;
import graphql.TypeResolutionEnvironment;
import graphql.collect.ImmutableMapWithNullValues;
import graphql.schema.DataFetchingFieldSelectionSet;
import graphql.schema.GraphQLSchema;
import graphql.schema.GraphQLType;

import java.util.Map;
import java.util.function.Supplier;

/**
 * This class is a classic builder style one that SHOULD have been on have been on {@link TypeResolutionEnvironment}
 * but for legacy reasons was not.  So it acts as the builder of {@link TypeResolutionEnvironment} objects
 */
@Internal
public class TypeResolutionParameters {

    private final MergedField field;
    private final GraphQLType fieldType;
    private final Object value;
    private final Supplier> argumentValues;
    private final GraphQLSchema schema;
    private final Object context;
    private final Object localContext;
    private final GraphQLContext graphQLContext;
    private final DataFetchingFieldSelectionSet selectionSet;

    private TypeResolutionParameters(Builder builder) {
        this.field = builder.field;
        this.fieldType = builder.fieldType;
        this.value = builder.value;
        this.argumentValues = builder.argumentValues;
        this.schema = builder.schema;
        this.context = builder.context;
        this.graphQLContext = builder.graphQLContext;
        this.localContext = builder.localContext;
        this.selectionSet = builder.selectionSet;
    }

    public MergedField getField() {
        return field;
    }

    public GraphQLType getFieldType() {
        return fieldType;
    }

    public Object getValue() {
        return value;
    }

    public Map getArgumentValues() {
        return argumentValues.get();
    }

    public GraphQLSchema getSchema() {
        return schema;
    }

    public DataFetchingFieldSelectionSet getSelectionSet() {
        return selectionSet;
    }

    public static Builder newParameters() {
        return new Builder();
    }

    /**
     * @return the legacy context object
     *
     * @deprecated use {@link #getGraphQLContext()} instead
     */
    @Deprecated(since = "2021-07-05")
    public Object getContext() {
        return context;
    }

    public GraphQLContext getGraphQLContext() {
        return graphQLContext;
    }

    public Object getLocalContext() {
        return localContext;
    }

    public static class Builder {

        private MergedField field;
        private GraphQLType fieldType;
        private Object value;
        private Supplier> argumentValues;
        private GraphQLSchema schema;
        private Object context;
        private GraphQLContext graphQLContext;
        private Object localContext;
        private DataFetchingFieldSelectionSet selectionSet;

        public Builder field(MergedField field) {
            this.field = field;
            return this;
        }

        public Builder fieldType(GraphQLType fieldType) {
            this.fieldType = fieldType;
            return this;
        }

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

        public Builder argumentValues(Supplier> argumentValues) {
            this.argumentValues = () -> ImmutableMapWithNullValues.copyOf(argumentValues.get());
            return this;
        }

        public Builder schema(GraphQLSchema schema) {
            this.schema = schema;
            return this;
        }

        @Deprecated(since = "2021-07-05")
        public Builder context(Object context) {
            this.context = context;
            return this;
        }

        public Builder graphQLContext(GraphQLContext context) {
            this.graphQLContext = context;
            return this;
        }

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

        public Builder selectionSet(DataFetchingFieldSelectionSet selectionSet) {
            this.selectionSet = selectionSet;
            return this;
        }

        public TypeResolutionEnvironment build() {
            // this build should have always been in TypeResolutionEnvironment but this little workaround improves it a smidge,
            // and we can fix it up later so this class is redundant
            return new TypeResolutionEnvironment(new TypeResolutionParameters(this));
        }
    }
}