org.springframework.web.servlet.mvc.method.annotation

Class ResponseBodyEmitterReturnValueHandler

java.lang.Object

org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitterReturnValueHandler

All Implemented Interfaces:

org.springframework.web.method.support.AsyncHandlerMethodReturnValueHandler, org.springframework.web.method.support.HandlerMethodReturnValueHandler

public class ResponseBodyEmitterReturnValueHandler
extends Object
implements org.springframework.web.method.support.AsyncHandlerMethodReturnValueHandler

Handler for return values of type ResponseBodyEmitter (and the ResponseEntity<ResponseBodyEmitter> sub-class) as well as any other async type with a registered adapter.

Since:

4.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ResponseBodyEmitterReturnValueHandler(List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)

Method Summary

Modifier and Type	Method and Description
Map<Class<?>,ResponseBodyEmitterAdapter>	getAdapterMap() Deprecated. in 4.3.8, see comments on ResponseBodyEmitterAdapter
void	handleReturnValue(Object returnValue, org.springframework.core.MethodParameter returnType, org.springframework.web.method.support.ModelAndViewContainer mavContainer, org.springframework.web.context.request.NativeWebRequest webRequest)
boolean	isAsyncReturnValue(Object returnValue, org.springframework.core.MethodParameter returnType)
boolean	supportsReturnType(org.springframework.core.MethodParameter returnType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseBodyEmitterReturnValueHandler

public ResponseBodyEmitterReturnValueHandler(List<org.springframework.http.converter.HttpMessageConverter<?>> messageConverters)

Method Detail

getAdapterMap

@Deprecated
public Map<Class<?>,ResponseBodyEmitterAdapter> getAdapterMap()

Deprecated. in 4.3.8, see comments on ResponseBodyEmitterAdapter

Return the map with ResponseBodyEmitter adapters. By default the map contains a single adapter ResponseBodyEmitter that simply downcasts the return value.

Returns:

the map of adapters

supportsReturnType

public boolean supportsReturnType(org.springframework.core.MethodParameter returnType)

Specified by:

supportsReturnType in interface org.springframework.web.method.support.HandlerMethodReturnValueHandler

isAsyncReturnValue

public boolean isAsyncReturnValue(Object returnValue,
                                  org.springframework.core.MethodParameter returnType)

Specified by:

isAsyncReturnValue in interface org.springframework.web.method.support.AsyncHandlerMethodReturnValueHandler

handleReturnValue

public void handleReturnValue(Object returnValue,
                              org.springframework.core.MethodParameter returnType,
                              org.springframework.web.method.support.ModelAndViewContainer mavContainer,
                              org.springframework.web.context.request.NativeWebRequest webRequest)
                       throws Exception

Specified by:

handleReturnValue in interface org.springframework.web.method.support.HandlerMethodReturnValueHandler

Throws:

Exception