public Class ViewControllerRegistration

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.servlet.config.annotation.ViewControllerRegistration

Imports

org.springframework.context.ApplicationContext, org.springframework.http.HttpStatusCode, org.springframework.lang.Nullable, org.springframework.util.Assert, org.springframework.web.servlet.RequestToViewNameTranslator, org.springframework.web.servlet.mvc.ParameterizableViewController

Assist with the registration of a single view controller.

Authors: Rossen Stoyanchev, Keith Donald
Since: 3.1

Field Summary

Modifier and Type	Field and Description
private final ParameterizableViewController	controller
private final String	urlPath

Constructor Summary

Access	Constructor and Description
public	ViewControllerRegistration(String urlPath)

Method Summary

Modifier and Type	Method and Description
protected String	getUrlPath()
protected ParameterizableViewController	getViewController()
protected void	setApplicationContext(ApplicationContext applicationContext)
public ViewControllerRegistration	setStatusCode(HttpStatusCode statusCode) Set the status code to set on the response.
public void	setViewName(String viewName) Set the view name to return.

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

Field Detail

controller	back to summary
private final ParameterizableViewController controller

urlPath	back to summary
private final String urlPath

Constructor Detail

ViewControllerRegistration	back to summary
public ViewControllerRegistration(String urlPath)

Method Detail

getUrlPath	back to summary
protected String getUrlPath()

getViewController	back to summary
protected ParameterizableViewController getViewController()

setApplicationContext	back to summary
protected void setApplicationContext(ApplicationContext applicationContext)

setStatusCode	back to summary
public ViewControllerRegistration setStatusCode(HttpStatusCode statusCode) Set the status code to set on the response. Optional. If not set the response status will be 200 (OK).

setStatusCode

back to summary

public ViewControllerRegistration setStatusCode(HttpStatusCode statusCode)

Set the status code to set on the response. Optional.

If not set the response status will be 200 (OK).

setViewName back to summary

setViewName	back to summary
public void setViewName(String viewName) Set the view name to return. Optional. If not specified, the view controller will return `null` as the view name in which case the configured `RequestToViewNameTranslator` will select the view name. The `DefaultRequestToViewNameTranslator` for example translates "/foo/bar" to "foo/bar". See Also `org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator`

public void setViewName(String viewName)

Set the view name to return. Optional.

If not specified, the view controller will return null as the view name in which case the configured RequestToViewNameTranslator will select the view name. The DefaultRequestToViewNameTranslator for example translates "/foo/bar" to "foo/bar".

See Also: org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator