@PathVariable's javadoc wrongly states it supports MultiValueMaps [SPR-16936]

[spring-projects-issues]

Allon Mureinik opened SPR-16936 and commented

@PathVariable's javadoc states that it supports MultiValueMap parameters (introduced by #16952), but by reading through the code, that does not seem to be the case (compare PathVariableMapMethodArgumentResolver to RequestParamMapMethodArgumentResolver).

Moreover, parsing MultipleValueMap is done according to the ";", and placing such a character in a path (e.g., consider something like "/app/{param}/show" would just break the path.

The documentation should be amended to remove the mention of MultiValueMap.

 

---

Affects: 4.3.17, 5.0.6

Issue Links:

• Improve Reference documentation @PathVariable, @RequestHeader & @RequestParam using Map<String, String> [SPR-12347] #16952 Improve Reference documentation @PathVariable, @RequestHeader & @RequestParam using Map<String, String>

Referenced from: pull request #1854, and commits a9dd927, 0b64bcd, 2573a54, 224fcc1

Backported to: 4.3.18

[spring-projects-issues]

Juergen Hoeller commented

Good catch! Rolled into master now, and about to be backported to 5.0.7 and 4.3.18.

[spring-projects-issues]

Juergen Hoeller commented

At the opportunity, I've also removed some outdated environment constraints (dating back to Servlet MVC vs Portlet MVC) from our annotation javadoc there.