com.introproventures.graphql.jpa.query.schema.GraphQLSchemaBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphql-jpa-query-schema Show documentation

Provides GraphQL JPA Query Schema Generation and Execution Support

The newest version!

/*
 * Copyright 2017 IntroPro Ventures Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.introproventures.graphql.jpa.query.schema;

import graphql.schema.GraphQLScalarType;
import graphql.schema.GraphQLSchema;

/**
 * GraphQL Schema Builder interface specification
 *
 * @author Igor Dianov
 *
 */
public interface GraphQLSchemaBuilder {
    /**
     * Configures the name of GraphQL Schema. Cannot be null or empty;
     *
     * @param value GraphQL schema name
     * @return this builder instance
     */
    GraphQLSchemaBuilder name(String value);

    /**
     * Configures the description of GraphQL Schema.
     *
     * @param value GraphQL schema description
     * @return this builder instance
     */
    GraphQLSchemaBuilder description(String value);

    /**
     * Add package path to scan for entities to be included in GraphQL Schema.
     * All Entities are included by default
     *
     * @param path GraphQL entitys package path
     * @return this builder instance
     */
    GraphQLSchemaBuilder entityPath(String path);

    /**
     * Add package path to scan for entities to be included in GraphQL Schema.
     *
     * @param instance GraphQL query naming strategy
     * @return this builder instance
     */
    GraphQLSchemaBuilder namingStrategy(NamingStrategy instance);

    /**
     * Register Java type scalar
     *
     * @param javaType class
     * @param scalarType GraphQL scalar instance
     * @return this builder instance
     */
    GraphQLSchemaBuilder scalar(Class javaType, GraphQLScalarType scalarType);

    /**
     * Use GraphQLIDType attribute for entity identifier attributes. Defaults to false.
     *
     * @param useGraphQLIDType fl
     * @return this builder instance
     */
    GraphQLSchemaBuilder graphQLIDType(boolean useGraphQLIDType);

    /**
     * Builds {code #GraphQLSchema} instance
     *
     * @return GraphQLSchema instance
     */
    GraphQLSchema build();
}