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

Class MatrixVariableMapMethodArgumentResolver

java.lang.Object

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

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class MatrixVariableMapMethodArgumentResolver
extends Object
implements HandlerMethodArgumentResolver

Resolves arguments of type Map annotated with @MatrixVariable where the annotation does not specify a name. In other words the purpose of this resolver is to provide access to multiple matrix variables, either all or associated with a specific path variable.

When a name is specified, an argument of type Map is considered to be a single attribute with a Map value, and is resolved by MatrixVariableMethodArgumentResolver instead.

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
MatrixVariableMapMethodArgumentResolver()

Method Summary

Modifier and Type	Method and Description
Object	resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest request, WebDataBinderFactory binderFactory) Resolves a method parameter into an argument value from a given request.
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 Detail

MatrixVariableMapMethodArgumentResolver

public MatrixVariableMapMethodArgumentResolver()

Method Detail

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

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

Description copied from interface: HandlerMethodArgumentResolver

Resolves a method parameter into an argument value from a given request. A ModelAndViewContainer provides access to the model for the request. A WebDataBinderFactory provides a way to create a WebDataBinder instance when needed for data binding and type conversion purposes.

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

request - 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