Package org.forum.server.graphql.util

Interface DataFetchersDelegateMutation

All Known Implementing Classes:
DataFetchersDelegateMutationImpl
public interface DataFetchersDelegateMutation
This interface contains the fata fetchers that are delegated in the bean that the implementation has to provide, when fetching fields for the Mutation GraphQL type, as defined in the provided GraphQL schema. Please read the wiki server page for more information on this.
Author:
generated by graphql-java-generator
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    createBoard(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, String name, Boolean publiclyAvailable)
    This method loads the data for Mutation.createBoard.
    Object
    createMember(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, MemberInput input)
    This method loads the data for Mutation.createMember.
    Object
    createPost(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, PostInput post)
    This method loads the data for Mutation.createPost.
    Object
    createPosts(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, List<PostInput> spam)
    This method loads the data for Mutation.createPosts.
    Object
    createTopic(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, TopicInput topic)
    This method loads the data for Mutation.createTopic.

  • Method Details

    • createBoard

      Object createBoard(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, String name, Boolean publiclyAvailable)
      This method loads the data for Mutation.createBoard. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a org.forum.server.graphql.Board)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<org.forum.server.graphql.Board> or a Flux<org.forum.server.graphql.Board>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<org.forum.server.graphql.Board>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<org.forum.server.graphql.Board>. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server. The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      name - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      publiclyAvailable - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      Throws:
      NoSuchElementException - This method may return a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.

    • createTopic

      Object createTopic(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, TopicInput topic)
      This method loads the data for Mutation.createTopic. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a org.forum.server.graphql.Topic)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<org.forum.server.graphql.Topic> or a Flux<org.forum.server.graphql.Topic>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<org.forum.server.graphql.Topic>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<org.forum.server.graphql.Topic>. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server. The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      topic - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      Throws:
      NoSuchElementException - This method may return a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.

    • createPost

      Object createPost(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, PostInput post)
      This method loads the data for Mutation.createPost. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a org.forum.server.graphql.Post)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<org.forum.server.graphql.Post> or a Flux<org.forum.server.graphql.Post>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<org.forum.server.graphql.Post>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<org.forum.server.graphql.Post>. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server. The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      post - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      Throws:
      NoSuchElementException - This method may return a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.

    • createPosts

      Object createPosts(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, List<PostInput> spam)
      This method loads the data for Mutation.createPosts. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a List<org.forum.server.graphql.Post>)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<List<org.forum.server.graphql.Post>> or a Flux<List<org.forum.server.graphql.Post>>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<List<org.forum.server.graphql.Post>>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<List<org.forum.server.graphql.Post>>. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server. The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      spam - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      Throws:
      NoSuchElementException - This method may return a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.

    • createMember

      Object createMember(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, MemberInput input)
      This method loads the data for Mutation.createMember. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a org.forum.server.graphql.Member)
      • Mono and Flux for asynchronous value(s). Supported for controller methods and for any DataFetcher as described in Reactive DataFetcher. This would typically be a Mono<org.forum.server.graphql.Member> or a Flux<org.forum.server.graphql.Member>
      • Kotlin coroutine and Flow are adapted to Mono and Flux
      • java.util.concurrent.Callable to have the value(s) produced asynchronously. For this to work, AnnotatedControllerConfigurer must be configured with an Executor. This would typically by a Callable<org.forum.server.graphql.Member>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<org.forum.server.graphql.Member>. This allows to use graphql-java java-dataloader to highly optimize the number of requests to the server. The principle is this one: The data loader collects all the data to load, avoid to load several times the same data, and allows parallel execution of the queries, if multiple queries are to be run.
      • A Publisher (instead of a Flux), for Subscription for instance
      Parameters:
      dataFetchingEnvironment - The GraphQL DataFetchingEnvironment. It gives you access to the full GraphQL context for this DataFetcher
      input - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      Throws:
      NoSuchElementException - This method may return a NoSuchElementException exception. In this case, the exception is trapped by the calling method, and the return is consider as null. This allows to use the Optional.get() method directly, without caring of whether or not there is a value. The generated code will take care of the NoSuchElementException exception.