Class ViewResolverComposite
- java.lang.Object
- org.springframework.web.servlet.view.ViewResolverComposite
- All Implemented Interfaces:
Aware
,InitializingBean
,ApplicationContextAware
,Ordered
,ServletContextAware
,ViewResolver
public class ViewResolverComposite extends Object implements ViewResolver, Ordered, InitializingBean, ApplicationContextAware, ServletContextAware
AViewResolver
that delegates to others.- Since:
- 4.1
- Author:
- Sebastien Deleuze, Rossen Stoyanchev
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary
Constructors Constructor Description ViewResolverComposite()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.int
getOrder()
Get the order value of this object.List<ViewResolver>
getViewResolvers()
Return the list of view viewResolvers to delegate to.View
resolveViewName(String viewName, Locale locale)
Resolve the given view by name.void
setApplicationContext(ApplicationContext applicationContext)
Set the ApplicationContext that this object runs in.void
setOrder(int order)
void
setServletContext(ServletContext servletContext)
Set theServletContext
that this object runs in.void
setViewResolvers(List<ViewResolver> viewResolvers)
Set the list of view viewResolvers to delegate to.
Constructor Detail
ViewResolverComposite
public ViewResolverComposite()
Method Detail
setViewResolvers
public void setViewResolvers(List<ViewResolver> viewResolvers)
Set the list of view viewResolvers to delegate to.
getViewResolvers
public List<ViewResolver> getViewResolvers()
Return the list of view viewResolvers to delegate to.
setOrder
public void setOrder(int order)
getOrder
public int getOrder()
Description copied from interface:Ordered
Get the order value of this object.Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet
load-on-startup
values).Same order values will result in arbitrary sort positions for the affected objects.
- Specified by:
getOrder
in interfaceOrdered
- Returns:
- the order value
- See Also:
Ordered.HIGHEST_PRECEDENCE
,Ordered.LOWEST_PRECEDENCE
setApplicationContext
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
Description copied from interface:ApplicationContextAware
Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.Invoked after population of normal bean properties but before an init callback such as
InitializingBean.afterPropertiesSet()
or a custom init-method. Invoked afterResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)
,ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)
andMessageSourceAware
, if applicable.- Specified by:
setApplicationContext
in interfaceApplicationContextAware
- Parameters:
applicationContext
- the ApplicationContext object to be used by this object- Throws:
ApplicationContextException
- in case of context initialization errorsBeansException
- if thrown by application context methods- See Also:
BeanInitializationException
setServletContext
public void setServletContext(ServletContext servletContext)
Description copied from interface:ServletContextAware
Set theServletContext
that this object runs in.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSet
or a custom init-method. Invoked after ApplicationContextAware'ssetApplicationContext
.- Specified by:
setServletContext
in interfaceServletContextAware
- Parameters:
servletContext
- ServletContext object to be used by this object- See Also:
InitializingBean.afterPropertiesSet()
,ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
afterPropertiesSet
public void afterPropertiesSet() throws Exception
Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Throws:
Exception
- in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason
resolveViewName
public View resolveViewName(String viewName, Locale locale) throws Exception
Description copied from interface:ViewResolver
Resolve the given view by name.Note: To allow for ViewResolver chaining, a ViewResolver should return
null
if a view with the given name is not defined in it. However, this is not required: Some ViewResolvers will always attempt to build View objects with the given name, unable to returnnull
(rather throwing an exception when View creation failed).- Specified by:
resolveViewName
in interfaceViewResolver
- Parameters:
viewName
- name of the view to resolvelocale
- Locale in which to resolve the view. ViewResolvers that support internationalization should respect this.- Returns:
- the View object, or
null
if not found (optional, to allow for ViewResolver chaining) - Throws:
Exception
- if the view cannot be resolved (typically in case of problems creating an actual View object)