public class PathVariableMethodArgumentResolver extends AbstractNamedValueMethodArgumentResolver implements UriComponentsContributor
PathVariable.
An @PathVariable is a named value that gets resolved from a URI template variable.
It is always required and does not have a default value to fall back on. See the base class
AbstractNamedValueMethodArgumentResolver
for more information on how named values are processed.
If the method parameter type is Map, the name specified in the annotation is used
to resolve the URI variable String value. The value is then converted to a Map via
type conversion, assuming a suitable Converter or PropertyEditor has been
registered.
A WebDataBinder is invoked to apply type conversion to resolved path variable
values that don't yet match the method parameter type.
AbstractNamedValueMethodArgumentResolver.NamedValueInfo| Constructor and Description |
|---|
PathVariableMethodArgumentResolver() |
| Modifier and Type | Method and Description |
|---|---|
void |
contributeMethodArgument(MethodParameter parameter,
java.lang.Object value,
UriComponentsBuilder builder,
java.util.Map<java.lang.String,java.lang.Object> uriVariables,
ConversionService conversionService)
Process the given method argument and either update the
UriComponentsBuilder or add to the map with URI variables
to use to expand the URI after all arguments are processed. |
protected AbstractNamedValueMethodArgumentResolver.NamedValueInfo |
createNamedValueInfo(MethodParameter parameter)
Create the
AbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter. |
protected java.lang.String |
formatUriValue(ConversionService cs,
TypeDescriptor sourceType,
java.lang.Object value) |
protected void |
handleMissingValue(java.lang.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 |
handleResolvedValue(java.lang.Object arg,
java.lang.String name,
MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest request)
Invoked after a value is resolved.
|
protected java.lang.Object |
resolveName(java.lang.String name,
MethodParameter parameter,
NativeWebRequest request)
Resolve the given parameter type and value name into an argument value.
|
boolean |
supportsParameter(MethodParameter parameter)
Whether this contributor supports the given method parameter.
|
handleMissingValue, resolveArgumentpublic boolean supportsParameter(MethodParameter parameter)
UriComponentsContributorsupportsParameter in interface HandlerMethodArgumentResolversupportsParameter in interface UriComponentsContributorparameter - the method parameter to checktrue if this resolver supports the supplied parameter;
false otherwiseprotected AbstractNamedValueMethodArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)
AbstractNamedValueMethodArgumentResolverAbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter. Implementations typically
retrieve the method annotation by means of MethodParameter.getParameterAnnotation(Class).createNamedValueInfo in class AbstractNamedValueMethodArgumentResolverparameter - the method parameter@Nullable protected java.lang.Object resolveName(java.lang.String name, MethodParameter parameter, NativeWebRequest request) throws java.lang.Exception
AbstractNamedValueMethodArgumentResolverresolveName in class AbstractNamedValueMethodArgumentResolvername - the name of the value being resolvedparameter - the method parameter to resolve to an argument value
(pre-nested in case of a Optional declaration)request - the current requestnull)java.lang.Exception - in case of errorsprotected void handleMissingValue(java.lang.String name,
MethodParameter parameter)
throws ServletRequestBindingException
AbstractNamedValueMethodArgumentResolverAbstractNamedValueMethodArgumentResolver.resolveName(String, MethodParameter, NativeWebRequest)
returned null and there is no default value. Subclasses typically throw an exception in this case.handleMissingValue in class AbstractNamedValueMethodArgumentResolvername - the name for the valueparameter - the method parameterServletRequestBindingExceptionprotected void handleResolvedValue(@Nullable java.lang.Object arg, java.lang.String name, MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest request)
AbstractNamedValueMethodArgumentResolverhandleResolvedValue in class AbstractNamedValueMethodArgumentResolverarg - the resolved argument valuename - the argument nameparameter - the argument parameter typemavContainer - the ModelAndViewContainer (may be null)request - the current requestpublic void contributeMethodArgument(MethodParameter parameter, java.lang.Object value, UriComponentsBuilder builder, java.util.Map<java.lang.String,java.lang.Object> uriVariables, ConversionService conversionService)
UriComponentsContributorUriComponentsBuilder or add to the map with URI variables
to use to expand the URI after all arguments are processed.contributeMethodArgument in interface UriComponentsContributorparameter - the controller method parameter (never null)value - the argument value (possibly null)builder - the builder to update (never null)uriVariables - a map to add URI variables to (never null)conversionService - a ConversionService to format values as Strings@Nullable protected java.lang.String formatUriValue(@Nullable ConversionService cs, @Nullable TypeDescriptor sourceType, java.lang.Object value)