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

Class PathVariableMapMethodArgumentResolver

java.lang.Object

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

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class PathVariableMapMethodArgumentResolver
extends Object
implements HandlerMethodArgumentResolver

Resolves Map method arguments annotated with @PathVariable where the annotation does not specify a path variable name. The resulting Map argument is a copy of all URI template name-value pairs.

Since:

3.2

Author:

Rossen Stoyanchev

See Also:

• PathVariableMethodArgumentResolver

Constructor Summary

Constructors

Constructor	Description
PathVariableMapMethodArgumentResolver()

Method Summary

Modifier and Type	Method	Description
Object	resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory)	Return a Map with all URI template variables or an empty map.
boolean	supportsParameter(MethodParameter parameter)	Whether the given method parameter is supported by this resolver.

Methods inherited from class java.lang.Object

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

Constructor Details

PathVariableMapMethodArgumentResolver

public PathVariableMapMethodArgumentResolver()

Method Details

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Description copied from interface: HandlerMethodArgumentResolver

Whether the given method parameter is supported by this resolver.

Specified by:

supportsParameter in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to check

Returns:

true if this resolver supports the supplied parameter; false otherwise

resolveArgument

public Object resolveArgument(MethodParameter parameter,
 @Nullable ModelAndViewContainer mavContainer,
 NativeWebRequest webRequest,
 @Nullable WebDataBinderFactory binderFactory)
                       throws Exception

Return a Map with all URI template variables or an empty map.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to resolve. This parameter must have previously been passed to HandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter) which must have returned true.

mavContainer - the ModelAndViewContainer for the current request

webRequest - the current request

binderFactory - a factory for creating WebDataBinder instances

Returns:

the resolved argument value, or null if not resolvable

Throws:

Exception - in case of errors with the preparation of argument values