Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation about when use BindingAwareModelMap and ExtendedModelMap [SPR-12896] #17495

Closed
spring-issuemaster opened this issue Apr 7, 2015 · 1 comment

Comments

@spring-issuemaster
Copy link
Collaborator

@spring-issuemaster spring-issuemaster commented Apr 7, 2015

Manuel Jordan opened SPR-12896 and commented

In the current
Spring Framework Reference Documentation

does not teach when should be use BindingAwareModelMap and ExtendedModelMap. Even worst, both terms do not appear in the reference documentation.

According with their APIs
BindingAwareModelMap
ExtendedModelMap
The latter is a superclass of the former. But the current explanation of BindingAwareModelMap is not solid (To be honest, I don't understand in a 100% the idea)

Thefore:

  • improve the API documentation for BindingAwareModelMap.
  • Include some explanation and examples (specially for testing) about these two classes in the reference documentation.
  • About testing (Spring MVC Test) give a clear the idea about when use BindingAwareModelMap and ExtendedModelMap for some specific scenario.

Thank you.


Affects: 4.1.6

@spring-issuemaster
Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Jul 7, 2015

Juergen Hoeller commented

Those classes are intentionally not mentioned in the reference documentation since there should be no need to refer to them in user code. They only get exposed to handler methods by Spring MVC, typically consumed through a declaration of the Model interface. There is no need to build those within user code; a plain ModelMap or even a just a regular Map with String keys will be good enough to return a user model.

I've clarified that arrangement in the corresponding javadoc.

Juergen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.