Package org.springframework.graphql.data.method.annotation.support

Class BatchLoaderHandlerMethod

java.lang.Object

org.springframework.graphql.data.method.HandlerMethod

org.springframework.graphql.data.method.InvocableHandlerMethodSupport

org.springframework.graphql.data.method.annotation.support.BatchLoaderHandlerMethod

public class BatchLoaderHandlerMethod
extends InvocableHandlerMethodSupport

An extension of HandlerMethod for annotated handler methods adapted to BatchLoaderWithContext or MappedBatchLoaderWithContext with the list of keys and BatchLoaderEnvironment as their input.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.graphql.data.method.HandlerMethod

HandlerMethod.HandlerMethodParameter

Field Summary

Fields inherited from class org.springframework.graphql.data.method.HandlerMethod

logger

Constructor Summary

Constructors

Constructor	Description
BatchLoaderHandlerMethod(HandlerMethod handlerMethod, Executor executor)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of alternative constructor
BatchLoaderHandlerMethod(HandlerMethod handlerMethod, Executor executor, boolean invokeAsync)	Create an instance.

Method Summary

Modifier and Type	Method	Description
<V> reactor.core.publisher.Flux<V>	invokeForIterable(Collection<?> keys, org.dataloader.BatchLoaderEnvironment environment)	Invoke the underlying batch loader method with a collection of input keys to return a collection of matching values.
<K, V> reactor.core.publisher.Mono<Map<K,V>>	invokeForMap(Collection<K> keys, org.dataloader.BatchLoaderEnvironment environment)	Invoke the underlying batch loader method with a collection of keys to return a Map of key-value pairs.

Methods inherited from class org.springframework.graphql.data.method.InvocableHandlerMethodSupport

doInvoke, toArgsMono

Methods inherited from class org.springframework.graphql.data.method.HandlerMethod

assertTargetBean, createWithResolvedBean, equals, findProvidedArgument, formatArgumentError, formatInvokeError, getBean, getBeanType, getBridgedMethod, getMethod, getMethodAnnotation, getMethodParameters, getReturnType, getReturnValueType, getShortLogMessage, hashCode, hasMethodAnnotation, isVoid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BatchLoaderHandlerMethod

@Deprecated(since="1.3.0",
            forRemoval=true)
public BatchLoaderHandlerMethod(HandlerMethod handlerMethod,
 @Nullable
 Executor executor)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of alternative constructor

Create an instance.

Parameters:

handlerMethod - the controller method

executor - an Executor to use for Callable return values

BatchLoaderHandlerMethod

public BatchLoaderHandlerMethod(HandlerMethod handlerMethod,
 @Nullable
 Executor executor,
 boolean invokeAsync)

Create an instance.

Parameters:

handlerMethod - the controller method

executor - an Executor to use for Callable return values

invokeAsync - whether to invoke the method through the Executor

Since:

1.3.0

Method Details

invokeForMap

@Nullable
public <K,
V> reactor.core.publisher.Mono<Map<K,V>> invokeForMap(Collection<K> keys,
 org.dataloader.BatchLoaderEnvironment environment)

Invoke the underlying batch loader method with a collection of keys to return a Map of key-value pairs.

Type Parameters:

K - the type of keys in the map

V - the type of values in the map

Parameters:

keys - the keys for which to load values

environment - the environment available to batch loaders

Returns:

a Mono with map of key-value pairs.

invokeForIterable

public <V> reactor.core.publisher.Flux<V> invokeForIterable(Collection<?> keys,
 org.dataloader.BatchLoaderEnvironment environment)

Invoke the underlying batch loader method with a collection of input keys to return a collection of matching values.

Type Parameters:

V - the type of values returned

Parameters:

keys - the keys for which to load values

environment - the environment available to batch loaders

Returns:

a Flux of values.