Configuring Content Negotiation Example Code Incorrect [SPR-10204]

[spring-projects-issues]

Michael Robinson opened SPR-10204 and commented

The example code in section 17.15.4 seems incorrect. I believe the line:

configurer.setFavorPathExtension(false).setFavorParameter(true);

should instead be:

configurer.favorPathExtension(false).favorParameter(true);

Thanks,
Michael

---

Affects: 3.2 GA

Reference URL: http://static.springsource.org/spring-framework/docs/3.2.x/spring-framework-reference/html/mvc.html#mvc-config-content-negotiation

Referenced from: commits 692ced8

[spring-projects-issues]

Rossen Stoyanchev commented

It actually is the correct method name:
https://github.com/SpringSource/spring-framework/blob/3.2.x/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ContentNegotiationConfigurer.java#L121

[spring-projects-issues]

Michael Robinson commented

Are you sure?

I see that the factory bean ContentNegotiationManagerFactoryBean has the method signature setFavorParameter(...) but the code example is attempting to call setFavorParameter(...) on the ContentNegotiationConfigurer supplied parameter which only has the signature of favorParameter(...)

[spring-projects-issues]

Michael Robinson commented

Full example from the docs is:

@Configuration
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter {

  @Override
  public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
    configurer.setFavorPathExtension(false).setFavorParameter(true);
  }
}

Copied and pasted this does not compile for me.

[spring-projects-issues]

Rossen Stoyanchev commented

Oops, my mistake. I read the description the other way around.

[spring-projects-issues]

Rossen Stoyanchev commented

Fixed, thanks!