程序包 cn.taketoday.web.bind.resolver

类 PathVariableMethodArgumentResolver

java.lang.Object

cn.taketoday.web.bind.resolver.AbstractNamedValueResolvingStrategy

cn.taketoday.web.bind.resolver.PathVariableMethodArgumentResolver

所有已实现的接口:

ParameterResolvingStrategy, UriComponentsContributor

public class PathVariableMethodArgumentResolver
extends AbstractNamedValueResolvingStrategy
implements UriComponentsContributor

Resolves method arguments annotated with an @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 AbstractNamedValueResolvingStrategy 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 has been registered.

从以下版本开始:

4.0 2022/2/3 16:32

作者:

Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private static final cn.taketoday.core.TypeDescriptor	STRING_TYPE_DESCRIPTOR

构造器概要

构造器

构造器	说明
PathVariableMethodArgumentResolver()

方法概要

修饰符和类型	方法	说明
void	contributeMethodArgument(cn.taketoday.core.MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables, cn.taketoday.core.conversion.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 String	formatUriValue(cn.taketoday.core.conversion.ConversionService cs, cn.taketoday.core.TypeDescriptor sourceType, Object value)
protected void	handleMissingValue(String name, cn.taketoday.core.MethodParameter parameter)	Invoked when a named value is required, but AbstractNamedValueResolvingStrategy.resolveName(String, ResolvableMethodParameter, RequestContext) returned null and there is no default value.
protected void	handleMissingValueAfterConversion(String name, cn.taketoday.core.MethodParameter parameter, RequestContext request)	Invoked when a named value is present but becomes null after conversion.
protected void	handleResolvedValue(Object arg, String name, ResolvableMethodParameter resolvable, RequestContext request)	Invoked after a value is resolved.
protected Object	resolveName(String name, ResolvableMethodParameter resolvable, RequestContext context)	Resolve the given parameter type and value name into an argument value.
boolean	supportsParameter(cn.taketoday.core.MethodParameter parameter)	Whether this contributor supports the given method parameter.
boolean	supportsParameter(ResolvableMethodParameter resolvable)	Whether the given parameter is supported by this resolver.

从类继承的方法 cn.taketoday.web.bind.resolver.AbstractNamedValueResolvingStrategy

getNamedValueInfo, handleMissingValue, resolveArgument

从类继承的方法 java.lang.Object

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

字段详细资料

STRING_TYPE_DESCRIPTOR

private static final cn.taketoday.core.TypeDescriptor STRING_TYPE_DESCRIPTOR

构造器详细资料

PathVariableMethodArgumentResolver

public PathVariableMethodArgumentResolver()

方法详细资料

supportsParameter

public boolean supportsParameter(ResolvableMethodParameter resolvable)

从接口复制的说明: ParameterResolvingStrategy

Whether the given parameter is supported by this resolver.

static match

指定者:

supportsParameter 在接口中 ParameterResolvingStrategy

resolveName

@Nullable
protected Object resolveName(String name,
 ResolvableMethodParameter resolvable,
 RequestContext context)
                      throws Exception

从类复制的说明: AbstractNamedValueResolvingStrategy

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

指定者:

resolveName 在类中 AbstractNamedValueResolvingStrategy

参数:

name - the name of the value being resolved

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

context - the current request context

返回:

the resolved argument (may be null)

抛出:

Exception - in case of errors

handleMissingValue

protected void handleMissingValue(String name,
 cn.taketoday.core.MethodParameter parameter)

从类复制的说明: AbstractNamedValueResolvingStrategy

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

覆盖:

handleMissingValue 在类中 AbstractNamedValueResolvingStrategy

参数:

name - the name for the value

parameter - the method parameter

handleMissingValueAfterConversion

protected void handleMissingValueAfterConversion(String name,
 cn.taketoday.core.MethodParameter parameter,
 RequestContext request)

从类复制的说明: AbstractNamedValueResolvingStrategy

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

覆盖:

handleMissingValueAfterConversion 在类中 AbstractNamedValueResolvingStrategy

参数:

name - the name for the value

parameter - the method parameter

request - the current request

handleResolvedValue

protected void handleResolvedValue(@Nullable
 Object arg,
 String name,
 ResolvableMethodParameter resolvable,
 RequestContext request)

从类复制的说明: AbstractNamedValueResolvingStrategy

Invoked after a value is resolved.

覆盖:

handleResolvedValue 在类中 AbstractNamedValueResolvingStrategy

参数:

arg - the resolved argument value

name - the argument name

resolvable - the argument parameter type

request - the current request

supportsParameter

public boolean supportsParameter(cn.taketoday.core.MethodParameter parameter)

从接口复制的说明: UriComponentsContributor

Whether this contributor supports the given method parameter.

指定者:

supportsParameter 在接口中 UriComponentsContributor

contributeMethodArgument

public void contributeMethodArgument(cn.taketoday.core.MethodParameter parameter,
 Object value,
 UriComponentsBuilder builder,
 Map<String,Object> uriVariables,
 cn.taketoday.core.conversion.ConversionService conversionService)

从接口复制的说明: UriComponentsContributor

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.

指定者:

contributeMethodArgument 在接口中 UriComponentsContributor

参数:

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

formatUriValue

@Nullable
protected String formatUriValue(@Nullable
 cn.taketoday.core.conversion.ConversionService cs,
 @Nullable
 cn.taketoday.core.TypeDescriptor sourceType,
 Object value)