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

Class MatrixVariableMethodArgumentResolver

java.lang.Object

org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver

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

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class MatrixVariableMethodArgumentResolver
extends AbstractNamedValueMethodArgumentResolver

Resolves arguments annotated with @MatrixVariable.

If the method parameter is of type Map it will be resolved by MatrixVariableMapMethodArgumentResolver instead unless the annotation specifies a name in which case it is considered to be a single attribute of type map (vs multiple attributes collected in a map).

Since:

3.2

Author:

Rossen Stoyanchev, Sam Brannen

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver

AbstractNamedValueMethodArgumentResolver.NamedValueInfo

Constructor Summary

Constructors

Constructor	Description
MatrixVariableMethodArgumentResolver()

Method Summary

Modifier and Type	Method	Description
protected AbstractNamedValueMethodArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter)	Create the AbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter.
protected void	handleMissingValue(String name, MethodParameter parameter)	Invoked when a named value is required, but AbstractNamedValueMethodArgumentResolver.resolveName(String, MethodParameter, NativeWebRequest) returned null and there is no default value.
protected void	handleMissingValueAfterConversion(String name, MethodParameter parameter, NativeWebRequest request)	Invoked when a named value is present but becomes null after conversion.
protected @Nullable Object	resolveName(String name, MethodParameter parameter, NativeWebRequest request)	Resolve the given parameter type and value name into an argument value.
boolean	supportsParameter(MethodParameter parameter)	Whether the given method parameter is supported by this resolver.

Methods inherited from class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver

handleMissingValue, handleResolvedValue, resolveArgument

Methods inherited from class java.lang.Object

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

Constructor Details

MatrixVariableMethodArgumentResolver

public MatrixVariableMethodArgumentResolver()

Method Details

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Description copied from interface: HandlerMethodArgumentResolver

Whether the given method parameter is supported by this resolver.

Parameters:

parameter - the method parameter to check

Returns:

true if this resolver supports the supplied parameter; false otherwise

createNamedValueInfo

protected AbstractNamedValueMethodArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Description copied from class: AbstractNamedValueMethodArgumentResolver

Create the AbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter. Implementations typically retrieve the method annotation by means of MethodParameter.getParameterAnnotation(Class).

Specified by:

createNamedValueInfo in class AbstractNamedValueMethodArgumentResolver

Parameters:

parameter - the method parameter

Returns:

the named value information

resolveName

protected @Nullable Object resolveName(String name,
 MethodParameter parameter,
 NativeWebRequest request)
                                throws Exception

Description copied from class: AbstractNamedValueMethodArgumentResolver

Resolve the given parameter type and value name into an argument value.

Specified by:

resolveName in class AbstractNamedValueMethodArgumentResolver

Parameters:

name - the name of the value being resolved

parameter - the method parameter to resolve to an argument value (pre-nested in case of a Optional declaration)

request - the current request

Returns:

the resolved argument (may be null)

Throws:

Exception - in case of errors

handleMissingValue

protected void handleMissingValue(String name,
 MethodParameter parameter)
                           throws ServletRequestBindingException

Description copied from class: AbstractNamedValueMethodArgumentResolver

Invoked when a named value is required, but AbstractNamedValueMethodArgumentResolver.resolveName(String, MethodParameter, NativeWebRequest) returned null and there is no default value. Subclasses typically throw an exception in this case.

Overrides:

handleMissingValue in class AbstractNamedValueMethodArgumentResolver

Parameters:

name - the name for the value

parameter - the method parameter

Throws:

ServletRequestBindingException

handleMissingValueAfterConversion

protected void handleMissingValueAfterConversion(String name,
 MethodParameter parameter,
 NativeWebRequest request)
                                          throws Exception

Description copied from class: AbstractNamedValueMethodArgumentResolver

Invoked when a named value is present but becomes null after conversion.

Overrides:

handleMissingValueAfterConversion in class AbstractNamedValueMethodArgumentResolver

Parameters:

name - the name for the value

parameter - the method parameter

request - the current request

Throws:

Exception