Spring Framework 6.1.4 · org.springframework.web.servlet.mvc.method.annotation.ModelAndViewMethodReturnValueHandler

Handles return values of type ModelAndView copying view and model information to the ModelAndViewContainer.

If the return value is null, the ModelAndViewContainer#setRequestHandled(boolean) flag is set to true to indicate the request was handled directly.

A ModelAndView return type has a set purpose. Therefore this handler should be configured ahead of handlers that support any return value type annotated with @ModelAttribute or @ResponseBody to ensure they don't take over.

Modifier and Type	Field and Description
private String[]	redirectPatterns

Constructor Summary

Access	Constructor and Description
public	ModelAndViewMethodReturnValueHandler()

Method Summary

Modifier and Type	Method and Description
public String[]	getRedirectPatterns() Return the configured redirect patterns, if any.
public void	handleReturnValue(Object the value returned from the handler method returnValue, MethodParameter the type of the return value. This type must have previously been passed to `supportsReturnType` which must have returned `true`. returnType, ModelAndViewContainer the ModelAndViewContainer for the current request mavContainer, NativeWebRequest the current request webRequest) Implements org.springframework.web.method.support.HandlerMethodReturnValueHandler.handleReturnValue. Handle the given return value by adding attributes to the model and setting a view or setting the `ModelAndViewContainer#setRequestHandled` flag to `true` to indicate the response has been handled directly.
protected boolean	Returns: "true" if the given view name is recognized as a redirect view reference; "false" otherwise. isRedirectViewName(String the view name to check, never `null` viewName) Whether the given view name is a redirect view reference.
public void	setRedirectPatterns(String... redirectPatterns) Configure one more simple patterns (as described in `PatternMatchUtils#simpleMatch`) to use in order to recognize custom redirect prefixes in addition to "redirect:".
public boolean	supportsReturnType(MethodParameter the method return type to check returnType) Implements org.springframework.web.method.support.HandlerMethodReturnValueHandler.supportsReturnType. Whether the given method return type is supported by this handler.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

redirectPatterns	back to summary
private String[] redirectPatterns Annotations @Nullable

Constructor Detail

ModelAndViewMethodReturnValueHandler	back to summary
public ModelAndViewMethodReturnValueHandler()

Method Detail

getRedirectPatterns	back to summary
public String[] getRedirectPatterns() Return the configured redirect patterns, if any. Annotations @Nullable Since 4.1

getRedirectPatterns

back to summary

public String[] getRedirectPatterns()

Return the configured redirect patterns, if any.

Annotations

@Nullable

Since

4.1

handleReturnValue back to summary

handleReturnValue	back to summary
public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception Implements org.springframework.web.method.support.HandlerMethodReturnValueHandler.handleReturnValue. Doc from org.springframework.web.method.support.HandlerMethodReturnValueHandler.handleReturnValue. Handle the given return value by adding attributes to the model and setting a view or setting the `ModelAndViewContainer#setRequestHandled` flag to `true` to indicate the response has been handled directly. Parameters returnValue:Object the value returned from the handler method returnType:MethodParameter the type of the return value. This type must have previously been passed to `supportsReturnType` which must have returned `true`. mavContainer:ModelAndViewContainer the ModelAndViewContainer for the current request webRequest:NativeWebRequest the current request Annotations @Override Exceptions Exception: if the return value handling results in an error

public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception

Implements org.springframework.web.method.support.HandlerMethodReturnValueHandler.handleReturnValue.

Doc from org.springframework.web.method.support.HandlerMethodReturnValueHandler.handleReturnValue.

Handle the given return value by adding attributes to the model and setting a view or setting the ModelAndViewContainer#setRequestHandled flag to true to indicate the response has been handled directly.

Parameters

returnValue:Object: the value returned from the handler method
returnType:MethodParameter: the type of the return value. This type must have previously been passed to supportsReturnType which must have returned true.
mavContainer:ModelAndViewContainer: the ModelAndViewContainer for the current request
webRequest:NativeWebRequest: the current request

Annotations

@Override

Exceptions

Exception:: if the return value handling results in an error

isRedirectViewName back to summary

isRedirectViewName	back to summary
protected boolean isRedirectViewName(String viewName) Whether the given view name is a redirect view reference. The default implementation checks the configured redirect patterns and also if the view name starts with the "redirect:" prefix. Parameters viewName:String the view name to check, never `null` Returns:boolean "true" if the given view name is recognized as a redirect view reference; "false" otherwise.

protected boolean isRedirectViewName(String viewName)

Whether the given view name is a redirect view reference. The default implementation checks the configured redirect patterns and also if the view name starts with the "redirect:" prefix.

Parameters

viewName:String: the view name to check, never null

Returns:boolean

"true" if the given view name is recognized as a redirect view reference; "false" otherwise.

setRedirectPatterns back to summary

setRedirectPatterns	back to summary
public void setRedirectPatterns(String... redirectPatterns) Configure one more simple patterns (as described in `PatternMatchUtils#simpleMatch`) to use in order to recognize custom redirect prefixes in addition to "redirect:". Note that simply configuring this property will not make a custom redirect prefix work. There must be a custom `View` that recognizes the prefix as well. Since 4.1

public void setRedirectPatterns(String... redirectPatterns)

Configure one more simple patterns (as described in PatternMatchUtils#simpleMatch) to use in order to recognize custom redirect prefixes in addition to "redirect:".

Note that simply configuring this property will not make a custom redirect prefix work. There must be a custom View that recognizes the prefix as well.

Since: 4.1

supportsReturnType back to summary

supportsReturnType	back to summary
public boolean supportsReturnType(MethodParameter returnType) Implements org.springframework.web.method.support.HandlerMethodReturnValueHandler.supportsReturnType. Doc from org.springframework.web.method.support.HandlerMethodReturnValueHandler.supportsReturnType. Whether the given method return type is supported by this handler. Parameters returnType:MethodParameter the method return type to check Returns:boolean `true` if this handler supports the supplied return type; `false` otherwise Annotations @Override

public boolean supportsReturnType(MethodParameter returnType)

Implements org.springframework.web.method.support.HandlerMethodReturnValueHandler.supportsReturnType.

Doc from org.springframework.web.method.support.HandlerMethodReturnValueHandler.supportsReturnType.

Whether the given method return type is supported by this handler.

Parameters

returnType:MethodParameter: the method return type to check

Returns:boolean

true if this handler supports the supplied return type; false otherwise

Annotations

@Override

public Class ModelAndViewMethodReturnValueHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail