org.springframework.web.method.support

Interface UriComponentsContributor

All Known Implementing Classes:

CompositeUriComponentsContributor, PathVariableMethodArgumentResolver, RequestParamMethodArgumentResolver

public interface UriComponentsContributor

Strategy for contributing to the building of a UriComponents by looking at a method parameter and an argument value and deciding what part of the target URL should be updated.

Since:

4.0

Author:

Oliver Gierke, Rossen Stoyanchev

Method Summary

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.
boolean	supportsParameter(MethodParameter parameter) Whether this contributor supports the given method parameter.

Method Detail

supportsParameter

boolean supportsParameter(MethodParameter parameter)

Whether this contributor supports the given method parameter.

contributeMethodArgument

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.

Parameters:

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