Top Description Constructors Methods
org.springframework.web.servlet.mvc.method.annotation

public Class ServletResponseMethodArgumentResolver

extends Object
implements HandlerMethodArgumentResolver
Class Inheritance
All Implemented Interfaces
org.springframework.web.method.support.HandlerMethodArgumentResolver
Imports
java.io.IOException, .OutputStream, .Writer, jakarta.servlet.ServletResponse, org.springframework.core.MethodParameter, org.springframework.lang.Nullable, org.springframework.web.bind.support.WebDataBinderFactory, org.springframework.web.context.request.NativeWebRequest, org.springframework.web.method.support.HandlerMethodArgumentResolver, .ModelAndViewContainer
Resolves servlet backed response-related method arguments. Supports values of the following types:
Authors
Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller
Since
3.1

Constructor Summary

AccessConstructor and Description
public
ServletResponseMethodArgumentResolver()

Method Summary

Modifier and TypeMethod and Description
public Object
resolveArgument(MethodParameter
the method parameter to resolve. This parameter must have previously been passed to supportsParameter which must have returned true.
parameter, ModelAndViewContainer
the ModelAndViewContainer for the current request
mavContainer, NativeWebRequest
the current request
webRequest, WebDataBinderFactory
a factory for creating WebDataBinder instances
binderFactory)

Implements org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

Set ModelAndViewContainer#setRequestHandled(boolean) to false to indicate that the method signature provides access to the response.

private Object
resolveArgument(Class<?> paramType, ServletResponse response)

private <T> T
resolveNativeResponse(NativeWebRequest webRequest, Class<T> requiredType)

public boolean
supportsParameter(MethodParameter
the method parameter to check
parameter)

Implements org.springframework.web.method.support.HandlerMethodArgumentResolver.supportsParameter.

Whether the given method parameter is supported by this resolver.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ServletResponseMethodArgumentResolverback to summary
public ServletResponseMethodArgumentResolver()

Method Detail

resolveArgumentback to summary
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception

Implements org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

Set ModelAndViewContainer#setRequestHandled(boolean) to false to indicate that the method signature provides access to the response. If subsequently the underlying method returns null, the request is considered directly handled.

Parameters
parameter:MethodParameter

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

the method parameter to resolve. This parameter must have previously been passed to supportsParameter which must have returned true.

mavContainer:ModelAndViewContainer

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

the ModelAndViewContainer for the current request

webRequest:NativeWebRequest

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

the current request

binderFactory:WebDataBinderFactory

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

a factory for creating WebDataBinder instances

Returns:Object

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

the resolved argument value, or null if not resolvable

Annotations
@Override
Exceptions
Exception:

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.resolveArgument.

in case of errors with the preparation of argument values

resolveArgumentback to summary
private Object resolveArgument(Class<?> paramType, ServletResponse response) throws IOException
resolveNativeResponseback to summary
private <T> T resolveNativeResponse(NativeWebRequest webRequest, Class<T> requiredType)
supportsParameterback to summary
public boolean supportsParameter(MethodParameter parameter)

Implements org.springframework.web.method.support.HandlerMethodArgumentResolver.supportsParameter.

Doc from org.springframework.web.method.support.HandlerMethodArgumentResolver.supportsParameter.

Whether the given method parameter is supported by this resolver.

Parameters
parameter:MethodParameter

the method parameter to check

Returns:boolean

true if this resolver supports the supplied parameter; false otherwise

Annotations
@Override