org.springframework.web.servlet.view.script

Class ScriptTemplateViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.springframework.web.servlet.view.script.ScriptTemplateViewResolver

All Implemented Interfaces:

Aware, ApplicationContextAware, Ordered, ServletContextAware, ViewResolver

public class ScriptTemplateViewResolver
extends UrlBasedViewResolver

Convenience subclass of UrlBasedViewResolver that supports ScriptTemplateView and custom subclasses of it.

The view class for all views created by this resolver can be specified via the UrlBasedViewResolver.setViewClass(Class) property.

Note: When chaining ViewResolvers this resolver will check for the existence of the specified template resources and only return a non-null View object if a template is actually found.

Since:

4.2

Author:

Sebastien Deleuze

See Also:

ScriptTemplateConfigurer

Field Summary

Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

DEFAULT_CACHE_LIMIT

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ScriptTemplateViewResolver() Sets the default view class to requiredViewClass(): by default ScriptTemplateView.
ScriptTemplateViewResolver(java.lang.String prefix, java.lang.String suffix) A convenience constructor that allows for specifying prefix and suffix as constructor arguments.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class<?>	requiredViewClass() Return the required type of view for this resolver.
View	resolveViewName(java.lang.String viewName, java.util.Locale locale) Resolve the given view by name.

Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

buildView, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRedirectHosts, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHosts, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

clearCache, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, setCache, setCacheLimit, setCacheUnresolved

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptTemplateViewResolver

public ScriptTemplateViewResolver()

Sets the default view class to requiredViewClass(): by default ScriptTemplateView.

ScriptTemplateViewResolver

public ScriptTemplateViewResolver(java.lang.String prefix,
                                  java.lang.String suffix)

A convenience constructor that allows for specifying prefix and suffix as constructor arguments.

Parameters:

prefix - the prefix that gets prepended to view names when building a URL

suffix - the suffix that gets appended to view names when building a URL

Since:

4.3

Method Detail

resolveViewName

public View resolveViewName(java.lang.String viewName,
                            java.util.Locale locale)
                     throws java.lang.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 return null (rather throwing an exception when View creation failed).

Specified by:

resolveViewName in interface ViewResolver

Overrides:

resolveViewName in class AbstractCachingViewResolver

Parameters:

viewName - name of the view to resolve

locale - 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:

java.lang.Exception - if the view cannot be resolved (typically in case of problems creating an actual View object)

requiredViewClass

protected java.lang.Class<?> requiredViewClass()

Description copied from class: UrlBasedViewResolver

Return the required type of view for this resolver. This implementation returns AbstractUrlBasedView.

Overrides:

requiredViewClass in class UrlBasedViewResolver

See Also:

AbstractUrlBasedView