Class ReactiveReturnValueHandler
java.lang.Object
org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler
org.springframework.messaging.handler.invocation.ReactiveReturnValueHandler
- All Implemented Interfaces:
AsyncHandlerMethodReturnValueHandler,HandlerMethodReturnValueHandler
Support for single-value reactive types (like
Mono or Single)
as a return value type.- Since:
- 5.1
- Author:
- Sebastien Deleuze
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanisAsyncReturnValue(Object returnValue, MethodParameter returnType) Whether the return value represents an asynchronous, Future-like type with success and error callbacks.booleansupportsReturnType(MethodParameter returnType) Whether the given method return type is supported by this handler.toListenableFuture(Object returnValue, MethodParameter returnType) Adapt the asynchronous return value to aListenableFuture.Methods inherited from class org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler
handleReturnValue
-
Constructor Details
-
ReactiveReturnValueHandler
public ReactiveReturnValueHandler() -
ReactiveReturnValueHandler
-
-
Method Details
-
supportsReturnType
Description copied from interface:HandlerMethodReturnValueHandlerWhether the given method return type is supported by this handler.- Parameters:
returnType- the method return type to check- Returns:
trueif this handler supports the supplied return type;falseotherwise
-
isAsyncReturnValue
Description copied from interface:AsyncHandlerMethodReturnValueHandlerWhether the return value represents an asynchronous, Future-like type with success and error callbacks. If this method returnstrue, thenAsyncHandlerMethodReturnValueHandler.toListenableFuture(java.lang.Object, org.springframework.core.MethodParameter)is invoked next. If it returnsfalse, thenHandlerMethodReturnValueHandler.handleReturnValue(java.lang.Object, org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>)is called.Note: this method will only be invoked after
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)is called and it returnstrue.- Specified by:
isAsyncReturnValuein interfaceAsyncHandlerMethodReturnValueHandler- Overrides:
isAsyncReturnValuein classAbstractAsyncReturnValueHandler- Parameters:
returnValue- the value returned from the handler methodreturnType- the type of the return value- Returns:
trueif the return value type represents an async value
-
toListenableFuture
Description copied from interface:AsyncHandlerMethodReturnValueHandlerAdapt the asynchronous return value to aListenableFuture. Implementations should consider returning an instance ofSettableListenableFuture. Return value handling will then continue when the ListenableFuture is completed with either success or error.Note: this method will only be invoked after
HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter)is called and it returnstrue.- Parameters:
returnValue- the value returned from the handler methodreturnType- the type of the return value- Returns:
- the resulting ListenableFuture, or
nullin which case no further handling will be performed
-