org.springframework.web.reactive.result.method.annotation

Class PathVariableMethodArgumentResolver

java.lang.Object

org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver

org.springframework.web.reactive.result.method.annotation.PathVariableMethodArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver, SyncHandlerMethodArgumentResolver

public class PathVariableMethodArgumentResolver
extends AbstractNamedValueSyncArgumentResolver

Resolves method arguments annotated with @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.

Since:

5.0

Author:

Rossen Stoyanchev, Juergen Hoeller

See Also:

PathVariableMapMethodArgumentResolver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	PathVariableMethodArgumentResolver.PathVariableNamedValueInfo

Nested classes/interfaces inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

AbstractNamedValueArgumentResolver.NamedValueInfo

Constructor Summary

Constructors

Constructor and Description
PathVariableMethodArgumentResolver(ConfigurableBeanFactory beanFactory)

Method Summary

Modifier and Type	Method and Description
protected AbstractNamedValueArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter) Create the AbstractNamedValueArgumentResolver.NamedValueInfo object for the given method parameter.
protected void	handleMissingValue(java.lang.String name, MethodParameter parameter) Invoked when a named value is required, but AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange) returned null and there is no default value.
protected void	handleResolvedValue(java.lang.Object arg, java.lang.String name, MethodParameter parameter, Model model, ServerWebExchange exchange) Invoked after a value is resolved.
protected java.util.Optional<java.lang.Object>	resolveNamedValue(java.lang.String name, MethodParameter parameter, ServerWebExchange exchange) An abstract method for synchronous resolution of method argument values that sub-classes must implement.
boolean	supportsParameter(MethodParameter parameter)

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver

resolveArgumentValue, resolveName

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

handleMissingValue, resolveArgument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentResolver

resolveArgument

Constructor Detail

PathVariableMethodArgumentResolver

public PathVariableMethodArgumentResolver(ConfigurableBeanFactory beanFactory)

Method Detail

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

createNamedValueInfo

protected AbstractNamedValueArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Description copied from class: AbstractNamedValueArgumentResolver

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

Specified by:

createNamedValueInfo in class AbstractNamedValueArgumentResolver

Parameters:

parameter - the method parameter

Returns:

the named value information

resolveNamedValue

protected java.util.Optional<java.lang.Object> resolveNamedValue(java.lang.String name,
                                                                 MethodParameter parameter,
                                                                 ServerWebExchange exchange)

Description copied from class: AbstractNamedValueSyncArgumentResolver

An abstract method for synchronous resolution of method argument values that sub-classes must implement.

Specified by:

resolveNamedValue in class AbstractNamedValueSyncArgumentResolver

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)

exchange - the current exchange

Returns:

the resolved argument value, if any

handleMissingValue

protected void handleMissingValue(java.lang.String name,
                                  MethodParameter parameter)

Description copied from class: AbstractNamedValueArgumentResolver

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

Overrides:

handleMissingValue in class AbstractNamedValueArgumentResolver

Parameters:

name - the name for the value

parameter - the method parameter

handleResolvedValue

protected void handleResolvedValue(java.lang.Object arg,
                                   java.lang.String name,
                                   MethodParameter parameter,
                                   Model model,
                                   ServerWebExchange exchange)

Description copied from class: AbstractNamedValueArgumentResolver

Invoked after a value is resolved.

Overrides:

handleResolvedValue in class AbstractNamedValueArgumentResolver

Parameters:

arg - the resolved argument value

name - the argument name

parameter - the argument parameter type

model - the model

exchange - the current exchange