com.expediagroup.graphql.generator.directives.KotlinSchemaDirectiveWiring.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphql-kotlin-schema-generator Show documentation
Code-only GraphQL schema generation for Kotlin
There is a newer version: 8.2.1
Show newest version
/*
 * Copyright 2019 Expedia, Inc
 *
 * 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
 *
 *     https://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.expediagroup.graphql.generator.directives

import graphql.schema.GraphQLArgument
import graphql.schema.GraphQLEnumType
import graphql.schema.GraphQLEnumValueDefinition
import graphql.schema.GraphQLFieldDefinition
import graphql.schema.GraphQLInputObjectField
import graphql.schema.GraphQLInputObjectType
import graphql.schema.GraphQLInterfaceType
import graphql.schema.GraphQLObjectType
import graphql.schema.GraphQLScalarType
import graphql.schema.GraphQLUnionType

/**
 * KotlinSchemaDirectiveWiring is used for enhancing/updating GraphQL type based on the specified directives.
 *
 *
 * NOTE: While the GraphQL spec allows specifying the directives on number of different types (@see graphql.introspection.Introspection#DirectiveLocation)
 * only fields have access to graphql.schema.DataFetcher that allows customizing runtime behavior.
 */
interface KotlinSchemaDirectiveWiring {

    /**
     * Modifies GraphQLObjectType by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLObjectType
     */
    fun onObject(environment: KotlinSchemaDirectiveEnvironment): GraphQLObjectType = environment.element

    /**
     * Modifies GraphQLFieldDefinition by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLFieldDefinition
     */
    fun onField(environment: KotlinFieldDirectiveEnvironment): GraphQLFieldDefinition = environment.element

    /**
     * Modifies GraphQLArgument by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLArgument
     */
    fun onArgument(environment: KotlinSchemaDirectiveEnvironment): GraphQLArgument = environment.element

    /**
     * Modifies GraphQLInterfaceType by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLInterfaceType
     */
    fun onInterface(environment: KotlinSchemaDirectiveEnvironment): GraphQLInterfaceType = environment.element

    /**
     * Modifies GraphQLUnionType by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLUnionType
     */
    fun onUnion(environment: KotlinSchemaDirectiveEnvironment): GraphQLUnionType = environment.element

    /**
     * Modifies GraphQLEnumType by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLEnumType
     */
    fun onEnum(environment: KotlinSchemaDirectiveEnvironment): GraphQLEnumType = environment.element

    /**
     * Modifies GraphQLEnumValueDefinition by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLEnumValueDefinition
     */
    fun onEnumValue(environment: KotlinSchemaDirectiveEnvironment): GraphQLEnumValueDefinition = environment.element

    /**
     * Modifies GraphQLScalarType by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLScalarType
     */
    fun onScalar(environment: KotlinSchemaDirectiveEnvironment): GraphQLScalarType = environment.element

    /**
     * Modifies GraphQLInputObjectType by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLInputObjectType
     */
    fun onInputObjectType(environment: KotlinSchemaDirectiveEnvironment): GraphQLInputObjectType = environment.element

    /**
     * Modifies GraphQLInputObjectField by applying specified directive.
     *
     * @param environment the wiring element
     *
     * @return modified GraphQLInputObjectField
     */
    fun onInputObjectField(environment: KotlinSchemaDirectiveEnvironment): GraphQLInputObjectField = environment.element

    @Suppress("UNCHECKED_CAST", "Detekt.ComplexMethod")
    fun wireOnEnvironment(environment: KotlinSchemaDirectiveEnvironment<*>) =
        when (environment.element) {
            is GraphQLArgument -> onArgument(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLEnumType -> onEnum(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLEnumValueDefinition -> onEnumValue(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLFieldDefinition -> onField(environment as KotlinFieldDirectiveEnvironment)
            is GraphQLInputObjectField -> onInputObjectField(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLInputObjectType -> onInputObjectType(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLInterfaceType -> onInterface(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLObjectType -> onObject(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLScalarType -> onScalar(environment as KotlinSchemaDirectiveEnvironment)
            is GraphQLUnionType -> onUnion(environment as KotlinSchemaDirectiveEnvironment)
            else -> environment.element
        }
}