Package org.allGraphQLCases.server

Interface DataFetchersDelegateTypeWithObject

All Known Implementing Classes:
DataFetchersDelegateTypeWithObjectImpl
public interface DataFetchersDelegateTypeWithObject
This interface contains the fata fetchers that are delegated in the bean that the implementation has to provide, when fetching fields for the TypeWithObject 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 Details

    • withArguments

      Object withArguments(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, STP_TypeWithObject_STS origin, String test, Date date, Long _long, Boolean _boolean, SEP_Episode_SES _enum, Object object, List<Object> objects)
      This method loads the data for TypeWithObject.withArguments. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a java.lang.String)
      • 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<java.lang.String> or a Flux<java.lang.String>
      • 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<java.lang.String>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<java.lang.String>. 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
      origin - The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the withArguments attribute of the origin, which is an instance of {ObjectType {name:TypeWithObject, fields:{Field{name:test, type:String, params:[]},Field{name:withArguments, type:String, params:[test:String,date:MyCustomScalarForADate!,long:Long!,boolean:Boolean!,enum:Episode!,object:Object!,objects:[Object!]!]},Field{name:date, type:MyCustomScalarForADate!, params:[]},Field{name:long, type:Long!, params:[]},Field{name:boolean, type:Boolean!, params:[]},Field{name:enum, type:Episode!, params:[]},Field{name:object, type:Object!, params:[]},Field{name:objects, type:[Object!]!, params:[]}}, comments ""}. It depends on your data modle, but it typically contains the id to use in the query.
      test - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      date - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      long - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      boolean - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      enum - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      object - The input parameter sent in the query by the GraphQL consumer, as defined in the GraphQL schema.
      objects - 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.

    • objects

      Object objects(graphql.schema.DataFetchingEnvironment dataFetchingEnvironment, STP_TypeWithObject_STS origin)
      This method loads the data for TypeWithObject.objects. It may return whatever is accepted by the Spring Controller, that is:
      • A resolved value of any type (typically, a List<java.lang.Object>)
      • 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<java.lang.Object>> or a Flux<List<java.lang.Object>>
      • 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<java.lang.Object>>
      As a complement to the spring-graphql documentation, you may also return:
      • A CompletableFuture<?>, for instance CompletableFuture<List<java.lang.Object>>. 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
      origin - The object from which the field is fetch. In other word: the aim of this data fetcher is to fetch the objects attribute of the origin, which is an instance of {ObjectType {name:TypeWithObject, fields:{Field{name:test, type:String, params:[]},Field{name:withArguments, type:String, params:[test:String,date:MyCustomScalarForADate!,long:Long!,boolean:Boolean!,enum:Episode!,object:Object!,objects:[Object!]!]},Field{name:date, type:MyCustomScalarForADate!, params:[]},Field{name:long, type:Long!, params:[]},Field{name:boolean, type:Boolean!, params:[]},Field{name:enum, type:Episode!, params:[]},Field{name:object, type:Object!, params:[]},Field{name:objects, type:[Object!]!, params:[]}}, comments ""}. It depends on your data modle, but it typically contains the id to use in the query.
      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.