Generated by
JDiff

org.springframework.web.method.support Documentation Differences

This file contains all the changes in documentation in the package org.springframework.web.method.support as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class ModelAndViewContainer

Records model and view related decisions made byby HandlerMethodArgumentResolvers and and HandlerMethodReturnValueHandlers during the course of invocation of of a controller method.

The .setRequestHandled flag can be used to indicate the request has been handled directly and view resolution is not required.

A default Model is automatically created at instantiation. An alternate model instance may be provided via .setRedirectModel for use in a redirect scenario. When .setRedirectModelScenario is set set to {@code true} signalling a redirect scenario, the .getModel() returns the redirect model instead of the default model. @author Rossen Stoyanchev @since 3.1

Class ModelAndViewContainer, ModelAndViewContainer addAllAttributes(Map<String, ?>)

Copy all attributes to the underlying model. A shortcut for {@seecode ModelMap#getModel().addAllAttributes(Map)}.
Class ModelAndViewContainer, ModelAndViewContainer addAttribute(Object)

Add the supplied attribute to the underlying model. A shortcut for {@seecode Model#getModel().addAttribute(Object)}.
Class ModelAndViewContainer, ModelAndViewContainer addAttribute(String, Object)

Add the supplied attribute to the underlying model. A shortcut for {@seecode ModelMap#getModel().addAttribute(String, Object)}.
Class ModelAndViewContainer, boolean containsAttribute(String)

Whether the underlying model contains the given attribute name. A shortcut for {@seecode ModelMap#getModel().containsAttribute(String)}.
Class ModelAndViewContainer, ModelMap getModel()

Return the model to use: the "default" or the "redirect" model.

The default model is used if {@code "redirectModelScenario=false"} or if the redirect model is {@code null} (i.e. it wasn't declared as aa method argument) and {@code ignoreDefaultModelOnRedirect=false}.

Class ModelAndViewContainer, SessionStatus getSessionStatus()

Return the SessionStatus instance to use that can be used to to signal that session processing is complete.
Class ModelAndViewContainer, String getViewName()

Return the view name to be resolved by the DispatcherServlet via a a ViewResolver, or {@code null} if a View object is set.
Class ModelAndViewContainer, boolean isViewReference()

Whether the view is a view reference specified via a name to bebe resolved by the DispatcherServlet via a ViewResolver.
Class ModelAndViewContainer, ModelAndViewContainer mergeAttributes(Map<String, ?>)

Copy attributes in the supplied Map with existing objects ofof the same name taking precedence (i.e. not getting replaced). A shortcut for {@seecode ModelMap#getModel().mergeAttributes(Map)}.
Class ModelAndViewContainer, void setIgnoreDefaultModelOnRedirect(boolean)

When set to {@code true} the default model is never used in a redirect scenario. So if a redirect model is not available, an empty model is is used instead.

When set to {@code false} the default model can be used in a redirect scenario if a redirect model is not available.

The default setting is {@code false}.

Class ModelAndViewContainer, void setRedirectModel(ModelMap)

Provide a separate model instance to use in a redirect scenario. The provided additional model however is not used used unless unless .setRedirectModelScenario(boolean) gets set to {@code true} to signal a redirect scenario.
Class ModelAndViewContainer, void setRequestHandled(boolean)

Signal a scenario where the request is handled directly.

A HandlerMethodReturnValueHandler may use this flag to to indicate the response has been fully handled and view resolution resolution is not required (e.g. {@code @ResponseBody}).

A HandlerMethodArgumentResolver may also use this flag to indicate the presence of an argument (e.g. {@code ServletResponse} or {@code OutputStream}) that may lead to to a complete response depending on the method return value.

The default value is {@code true}.

Class ModelAndViewContainer, void setView(Object)

Set a View object to be used by the DispatcherServlet. Will override any pre-existing view name or View.
Class ModelAndViewContainer, void setViewName(String)

Set a view name to be resolved by the DispatcherServlet via a ViewResolver. Will override any pre-existing view name or View.