Class CompositeUriComponentsContributor
- java.lang.Object
- org.springframework.web.method.support.CompositeUriComponentsContributor
- All Implemented Interfaces:
UriComponentsContributor
public class CompositeUriComponentsContributor extends Object implements UriComponentsContributor
AUriComponentsContributorcontaining a list of other contributors to delegate and also encapsulating a specificConversionServiceto use for formatting method argument values to Strings.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description CompositeUriComponentsContributor(Collection<?> contributors)Create an instance from a collection ofUriComponentsContributors orHandlerMethodArgumentResolvers.CompositeUriComponentsContributor(Collection<?> contributors, ConversionService cs)Create an instance from a collection ofUriComponentsContributors orHandlerMethodArgumentResolvers.CompositeUriComponentsContributor(UriComponentsContributor... contributors)Create an instance from a collection ofUriComponentsContributors orHandlerMethodArgumentResolvers.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcontributeMethodArgument(MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables)An overloaded method that uses the ConversionService created at construction.voidcontributeMethodArgument(MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables, ConversionService conversionService)Process the given method argument and either update theUriComponentsBuilderor add to the map with URI variables to use to expand the URI after all arguments are processed.booleanhasContributors()booleansupportsParameter(MethodParameter parameter)Whether this contributor supports the given method parameter.
Constructor Detail
CompositeUriComponentsContributor
public CompositeUriComponentsContributor(UriComponentsContributor... contributors)
Create an instance from a collection ofUriComponentsContributors orHandlerMethodArgumentResolvers. Since both of these tend to be implemented by the same class, the most convenient option is to obtain the configuredHandlerMethodArgumentResolversinRequestMappingHandlerAdapterand provide that to this constructor.- Parameters:
contributors- a collection ofUriComponentsContributororHandlerMethodArgumentResolvers.
CompositeUriComponentsContributor
public CompositeUriComponentsContributor(Collection<?> contributors)
Create an instance from a collection ofUriComponentsContributors orHandlerMethodArgumentResolvers. Since both of these tend to be implemented by the same class, the most convenient option is to obtain the configuredHandlerMethodArgumentResolversinRequestMappingHandlerAdapterand provide that to this constructor.- Parameters:
contributors- a collection ofUriComponentsContributororHandlerMethodArgumentResolvers.
CompositeUriComponentsContributor
public CompositeUriComponentsContributor(Collection<?> contributors, ConversionService cs)
Create an instance from a collection ofUriComponentsContributors orHandlerMethodArgumentResolvers. Since both of these tend to be implemented by the same class, the most convenient option is to obtain the configuredHandlerMethodArgumentResolversin theRequestMappingHandlerAdapterand provide that to this constructor.If the
ConversionServiceargument isnull,DefaultFormattingConversionServicewill be used by default.- Parameters:
contributors- a collection ofUriComponentsContributororHandlerMethodArgumentResolvers.cs- a ConversionService to use when method argument values need to be formatted as Strings before being added to the URI
Method Detail
hasContributors
public boolean hasContributors()
supportsParameter
public boolean supportsParameter(MethodParameter parameter)
Description copied from interface:UriComponentsContributorWhether this contributor supports the given method parameter.- Specified by:
supportsParameterin interfaceUriComponentsContributor
contributeMethodArgument
public void contributeMethodArgument(MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables, ConversionService conversionService)
Description copied from interface:UriComponentsContributorProcess the given method argument and either update theUriComponentsBuilderor add to the map with URI variables to use to expand the URI after all arguments are processed.- Specified by:
contributeMethodArgumentin interfaceUriComponentsContributor- Parameters:
parameter- the controller method parameter (nevernull)value- the argument value (possiblynull)builder- the builder to update (nevernull)uriVariables- a map to add URI variables to (nevernull)conversionService- a ConversionService to format values as Strings
contributeMethodArgument
public void contributeMethodArgument(MethodParameter parameter, Object value, UriComponentsBuilder builder, Map<String,Object> uriVariables)
An overloaded method that uses the ConversionService created at construction.