spring-webmvc

org.springframework.web.servlet.mvc.method.annotation
Class ViewNameMethodReturnValueHandler

java.lang.Object
  extended by org.springframework.web.servlet.mvc.method.annotation.ViewNameMethodReturnValueHandler
All Implemented Interfaces:
org.springframework.web.method.support.HandlerMethodReturnValueHandler

public class ViewNameMethodReturnValueHandler
extends java.lang.Object
implements org.springframework.web.method.support.HandlerMethodReturnValueHandler

Handles return values of types void and String interpreting them as view name reference.

A null return value, either due to a void return type or as the actual return value is left as-is allowing the configured RequestToViewNameTranslator to select a view name by convention.

A String return value can be interpreted in more than one ways depending on the presence of annotations like @ModelAttribute or @ResponseBody. Therefore this handler should be configured after the handlers that support these annotations.

Since:
3.1
Author:
Rossen Stoyanchev

Constructor Summary
ViewNameMethodReturnValueHandler()
           
 
Method Summary
 void handleReturnValue(java.lang.Object returnValue, org.springframework.core.MethodParameter returnType, org.springframework.web.method.support.ModelAndViewContainer mavContainer, org.springframework.web.context.request.NativeWebRequest webRequest)
           
protected  boolean isRedirectViewName(java.lang.String viewName)
          Whether the given view name is a redirect view reference.
 boolean supportsReturnType(org.springframework.core.MethodParameter returnType)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewNameMethodReturnValueHandler

public ViewNameMethodReturnValueHandler()
Method Detail

supportsReturnType

public boolean supportsReturnType(org.springframework.core.MethodParameter returnType)
Specified by:
supportsReturnType in interface org.springframework.web.method.support.HandlerMethodReturnValueHandler

handleReturnValue

public void handleReturnValue(java.lang.Object returnValue,
                              org.springframework.core.MethodParameter returnType,
                              org.springframework.web.method.support.ModelAndViewContainer mavContainer,
                              org.springframework.web.context.request.NativeWebRequest webRequest)
                       throws java.lang.Exception
Specified by:
handleReturnValue in interface org.springframework.web.method.support.HandlerMethodReturnValueHandler
Throws:
java.lang.Exception

isRedirectViewName

protected boolean isRedirectViewName(java.lang.String viewName)
Whether the given view name is a redirect view reference.

Parameters:
viewName - the view name to check, never null
Returns:
"true" if the given view name is recognized as a redirect view reference; "false" otherwise.

spring-webmvc