Spring Framework 6.1.4 · org.springframework.messaging.handler.invocation.AsyncHandlerMethodReturnValueHandler

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the return value type represents an async value isAsyncReturnValue(Object the value returned from the handler method returnValue, MethodParameter the type of the return value returnType) Whether the return value represents an asynchronous, Future-like type with success and error callbacks.
public CompletableFuture<?>	Returns: the resulting CompletableFuture, or `null` in which case no further handling will be performed toCompletableFuture(Object the value returned from the handler method returnValue, MethodParameter the type of the return value returnType) Adapt the asynchronous return value to a `CompletableFuture`.
public default ListenableFuture<?>	Returns: the resulting ListenableFuture, or `null` in which case no further handling will be performed toListenableFuture(Object the value returned from the handler method returnValue, MethodParameter the type of the return value returnType) Deprecated since 6.0. as of 6.0, in favor of `toCompletableFuture(Object, MethodParameter)` Adapt the asynchronous return value to a `ListenableFuture`.

Inherited from org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler:: handleReturnValue supportsReturnType

Method Detail

isAsyncReturnValue back to summary

isAsyncReturnValue	back to summary
public boolean isAsyncReturnValue(Object returnValue, MethodParameter returnType) Whether the return value represents an asynchronous, Future-like type with success and error callbacks. If this method returns `true`, then `toCompletableFuture` is invoked next. If it returns `false`, then `handleReturnValue` is called. Note this method will only be invoked after `supportsReturnType(org.springframework.core.MethodParameter)` is called and it returns `true`. Parameters returnValue:Object the value returned from the handler method returnType:MethodParameter the type of the return value Returns:boolean `true` if the return value type represents an async value

public boolean isAsyncReturnValue(Object returnValue, MethodParameter returnType)

Whether the return value represents an asynchronous, Future-like type with success and error callbacks. If this method returns true, then toCompletableFuture is invoked next. If it returns false, then handleReturnValue is called.

Note

this method will only be invoked after supportsReturnType(org.springframework.core.MethodParameter) is called and it returns true.

Parameters

returnValue:Object: the value returned from the handler method
returnType:MethodParameter: the type of the return value

Returns:boolean

true if the return value type represents an async value

toCompletableFuture back to summary

toCompletableFuture	back to summary
public CompletableFuture<?> toCompletableFuture(Object returnValue, MethodParameter returnType) Adapt the asynchronous return value to a `CompletableFuture`. Return value handling will then continue when the CompletableFuture is completed with either success or error. Note this method will only be invoked after `supportsReturnType(org.springframework.core.MethodParameter)` is called and it returns `true`. Parameters returnValue:Object the value returned from the handler method returnType:MethodParameter the type of the return value Returns:CompletableFuture<?> the resulting CompletableFuture, or `null` in which case no further handling will be performed Annotations @Nullable Since 6.0

public CompletableFuture<?> toCompletableFuture(Object returnValue, MethodParameter returnType)

Adapt the asynchronous return value to a CompletableFuture.

Return value handling will then continue when the CompletableFuture is completed with either success or error.

Note

this method will only be invoked after supportsReturnType(org.springframework.core.MethodParameter) is called and it returns true.

Parameters

returnValue:Object: the value returned from the handler method
returnType:MethodParameter: the type of the return value

Returns:CompletableFuture<?>

the resulting CompletableFuture, or null in which case no further handling will be performed

Annotations

@Nullable

Since

6.0

toListenableFuture back to summary

toListenableFuture	back to summary
public default ListenableFuture<?> toListenableFuture(Object returnValue, MethodParameter returnType) Deprecated since 6.0. as of 6.0, in favor of `toCompletableFuture(Object, MethodParameter)` Adapt the asynchronous return value to a `ListenableFuture`. Implementations should consider returning an instance of `SettableListenableFuture`. Return value handling will then continue when the ListenableFuture is completed with either success or error. Note this method will only be invoked after `supportsReturnType(org.springframework.core.MethodParameter)` is called and it returns `true`. Parameters returnValue:Object the value returned from the handler method returnType:MethodParameter the type of the return value Returns:ListenableFuture<?> the resulting ListenableFuture, or `null` in which case no further handling will be performed Annotations @Deprecated since:6.0 @Nullable

public default ListenableFuture<?> toListenableFuture(Object returnValue, MethodParameter returnType)

Deprecated

since 6.0.

as of 6.0, in favor of toCompletableFuture(Object, MethodParameter)

Adapt the asynchronous return value to a ListenableFuture.

Implementations should consider returning an instance of SettableListenableFuture. Return value handling will then continue when the ListenableFuture is completed with either success or error.

Note

this method will only be invoked after supportsReturnType(org.springframework.core.MethodParameter) is called and it returns true.

Parameters

returnValue:Object: the value returned from the handler method
returnType:MethodParameter: the type of the return value

Returns:ListenableFuture<?>

the resulting ListenableFuture, or null in which case no further handling will be performed

Annotations

@Deprecated
since:6.0
@Nullable

public Interface AsyncHandlerMethodReturnValueHandler

Method Summary

Method Detail