Class ServletRequestMethodArgumentResolver
- java.lang.Object
- org.springframework.web.servlet.mvc.method.annotation.ServletRequestMethodArgumentResolver
- All Implemented Interfaces:
HandlerMethodArgumentResolver
public class ServletRequestMethodArgumentResolver extends Object implements HandlerMethodArgumentResolver
Resolves servlet backed request-related method arguments. Supports values of the following types:WebRequestServletRequestMultipartRequestHttpSessionPushBuilder(as of Spring 5.0 on Servlet 4.0)PrincipalInputStreamReaderHttpMethod(as of Spring 4.0)LocaleTimeZone(as of Spring 4.0)ZoneId(as of Spring 4.0 and Java 8)
- Since:
- 3.1
- Author:
- Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller
Constructor Summary
Constructors Constructor Description ServletRequestMethodArgumentResolver()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ObjectresolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory)Resolves a method parameter into an argument value from a given request.booleansupportsParameter(MethodParameter parameter)Whether the given method parameter is supported by this resolver.
Constructor Detail
ServletRequestMethodArgumentResolver
public ServletRequestMethodArgumentResolver()
Method Detail
supportsParameter
public boolean supportsParameter(MethodParameter parameter)
Description copied from interface:HandlerMethodArgumentResolverWhether the given method parameter is supported by this resolver.- Specified by:
supportsParameterin interfaceHandlerMethodArgumentResolver- Parameters:
parameter- the method parameter to check- Returns:
trueif this resolver supports the supplied parameter;falseotherwise
resolveArgument
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception
Description copied from interface:HandlerMethodArgumentResolverResolves a method parameter into an argument value from a given request. AModelAndViewContainerprovides access to the model for the request. AWebDataBinderFactoryprovides a way to create aWebDataBinderinstance when needed for data binding and type conversion purposes.- Specified by:
resolveArgumentin interfaceHandlerMethodArgumentResolver- Parameters:
parameter- the method parameter to resolve. This parameter must have previously been passed toHandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter)which must have returnedtrue.mavContainer- the ModelAndViewContainer for the current requestwebRequest- the current requestbinderFactory- a factory for creatingWebDataBinderinstances- Returns:
- the resolved argument value, or
nullif not resolvable - Throws:
Exception- in case of errors with the preparation of argument values