graphql.annotations.processor.graphQLProcessors.GraphQLAnnotationsProcessor Maven / Gradle / Ivy

Go to download

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

Annotations-based syntax for GraphQL schema definition

There is a newer version: 21.5

Show newest version

/**
 * Copyright 2016 Yurii Rashkovskii
 *
 * 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
 */
package graphql.annotations.processor.graphQLProcessors;

import graphql.annotations.processor.typeFunctions.TypeFunction;
import graphql.relay.Relay;

public interface GraphQLAnnotationsProcessor {
    /**
     * Register a new type extension class. This extension will be used when the extended object will be created.
     * The class must have a {@link graphql.annotations.annotationTypes.GraphQLTypeExtension} annotation.
     *
     * @param objectClass The extension class to register
     */
    void registerTypeExtension(Class objectClass);

    /**
     * Allows you to set a custom relay object
     *
     * @param relay The extension class to register
     */
    void setRelay(Relay relay);

    /**
     * Allows you to register a new type function
     *
     * @param typeFunction The extension class to register
     */
    void registerTypeFunction(TypeFunction typeFunction);
}