Spring Framework 6.1.4 · org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandler

public Interface HandlerMethodReturnValueHandler

Handle the return value from the invocation of an annotated Message handling method.

Author

Rossen Stoyanchev

Since

5.2

Field Summary

Modifier and Type	Field and Description
public static final String	DATA_BUFFER_FACTORY_HEADER Header containing a DataBufferFactory for use in return value handling.

Modifier and Type	Method and Description
public Mono<Void>	Returns: `Mono<Void>` to indicate when handling is complete. handleReturnValue(Object the value returned from the handler method returnValue, MethodParameter the type of the return value. This type must have previously been passed to `supportsReturnType(MethodParameter)` and it must have returned `true`. returnType, Message<?> message) Handle the given return value.
public boolean	Returns: `true` if this handler supports the supplied return type; `false` otherwise supportsReturnType(MethodParameter the method return type to check returnType) Whether the given method return type is supported by this handler.

DATA_BUFFER_FACTORY_HEADER	back to summary
public static final String DATA_BUFFER_FACTORY_HEADER Header containing a DataBufferFactory for use in return value handling.

handleReturnValue back to summary

handleReturnValue	back to summary
public Mono<Void> handleReturnValue(Object returnValue, MethodParameter returnType, Message<?> message) Handle the given return value. Parameters returnValue:Object the value returned from the handler method returnType:MethodParameter the type of the return value. This type must have previously been passed to `supportsReturnType(MethodParameter)` and it must have returned `true`. Returns:Mono<Void> `Mono<Void>` to indicate when handling is complete.

public Mono<Void> handleReturnValue(Object returnValue, MethodParameter returnType, Message<?> message)

Handle the given return value.

Parameters

returnValue:Object: the value returned from the handler method
returnType:MethodParameter: the type of the return value. This type must have previously been passed to supportsReturnType(MethodParameter) and it must have returned true.

Returns:Mono<Void>

Mono<Void> to indicate when handling is complete.

supportsReturnType back to summary

supportsReturnType	back to summary
public boolean supportsReturnType(MethodParameter returnType) Whether the given method return type is supported by this handler. Parameters returnType:MethodParameter the method return type to check Returns:boolean `true` if this handler supports the supplied return type; `false` otherwise

public boolean supportsReturnType(MethodParameter returnType)

Whether the given method return type is supported by this handler.

Parameters

Returns:boolean

true if this handler supports the supplied return type; false otherwise