org.springframework.web.servlet.view.groovy.GroovyMarkupViewResolver Maven / Gradle / Ivy
/*
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.servlet.view.groovy;
import java.util.Locale;
import org.springframework.web.servlet.view.AbstractTemplateViewResolver;
import org.springframework.web.servlet.view.AbstractUrlBasedView;
/**
* Convenience subclass of {@link AbstractTemplateViewResolver} that supports
* {@link GroovyMarkupView} (i.e. Groovy XML/XHTML markup templates) and
* custom subclasses of it.
*
* The view class for all views created by this resolver can be specified
* via {@link #setViewClass(Class)}.
*
*
Note: When chaining ViewResolvers this resolver will check for the
* existence of the specified template resources and only return a non-null
* {@code View} object if a template is actually found.
*
* @author Brian Clozel
* @since 4.1
* @see GroovyMarkupConfigurer
*/
public class GroovyMarkupViewResolver extends AbstractTemplateViewResolver {
/**
* Sets the default {@link #setViewClass view class} to {@link #requiredViewClass}:
* by default {@link GroovyMarkupView}.
*/
public GroovyMarkupViewResolver() {
setViewClass(requiredViewClass());
}
/**
* A convenience constructor that allows for specifying the {@link #setPrefix prefix}
* and {@link #setSuffix suffix} as constructor arguments.
* @param prefix the prefix that gets prepended to view names when building a URL
* @param suffix the suffix that gets appended to view names when building a URL
* @since 4.3
*/
public GroovyMarkupViewResolver(String prefix, String suffix) {
this();
setPrefix(prefix);
setSuffix(suffix);
}
@Override
protected Class requiredViewClass() {
return GroovyMarkupView.class;
}
@Override
protected AbstractUrlBasedView instantiateView() {
return (getViewClass() == GroovyMarkupView.class ? new GroovyMarkupView() : super.instantiateView());
}
/**
* This resolver supports i18n, so cache keys should contain the locale.
*/
@Override
protected Object getCacheKey(String viewName, Locale locale) {
return viewName + '_' + locale;
}
}