View Javadoc
1   /*
2    * Copyright 2002-2009 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.web.servlet.view.freemarker;
18  
19  import freemarker.ext.jsp.TaglibFactory;
20  import freemarker.template.Configuration;
21  
22  /**
23   * Interface to be implemented by objects that configure and manage a
24   * FreeMarker Configuration object in a web environment. Detected and
25   * used by {@link FreeMarkerView}.
26   *
27   * @author Darren Davison
28   * @author Rob Harrop
29   * @since 03.03.2004
30   * @see FreeMarkerConfigurer
31   * @see FreeMarkerView
32   */
33  public interface FreeMarkerConfig {
34  
35  	/**
36  	 * Return the FreeMarker Configuration object for the current
37  	 * web application context.
38  	 * <p>A FreeMarker Configuration object may be used to set FreeMarker
39  	 * properties and shared objects, and allows to retrieve templates.
40  	 * @return the FreeMarker Configuration
41  	 */
42  	Configuration getConfiguration();
43  
44  	/**
45  	 * Returns the {@link TaglibFactory} used to enable JSP tags to be
46  	 * accessed from FreeMarker templates.
47  	 */
48  	TaglibFactory getTaglibFactory();
49  
50  }