1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.velocity;
24  
25  import com.liferay.portal.SystemException;
26  
27  import java.io.IOException;
28  import java.io.Writer;
29  
30  /**
31   * <a href="VelocityEngineUtil.java.html"><b><i>View Source</i></b></a>
32   *
33   * @author Raymond Augé
34   */
35  public class VelocityEngineUtil {
36  
37      public static void flushTemplate(String resource) {
38          getVelocityEngine().flushTemplate(resource);
39      }
40  
41      public static VelocityEngine getVelocityEngine() {
42          return _velocityEngine;
43      }
44  
45      public static void init() {
46          getVelocityEngine().init();
47      }
48  
49      public static VelocityContext getEmptyContext() {
50          return getVelocityEngine().getEmptyContext();
51      }
52  
53      public static VelocityContext getRestrictedToolsContext() {
54          return getVelocityEngine().getRestrictedToolsContext();
55      }
56  
57      public static VelocityContext getStandardToolsContext() {
58          return getVelocityEngine().getStandardToolsContext();
59      }
60  
61      public static VelocityContext getWrappedRestrictedToolsContext() {
62          return getVelocityEngine().getWrappedRestrictedToolsContext();
63      }
64  
65      public static VelocityContext getWrappedStandardToolsContext() {
66          return getVelocityEngine().getWrappedStandardToolsContext();
67      }
68  
69      public static boolean mergeTemplate(
70              String velocityTemplateId, VelocityContext velocityContext,
71              Writer writer)
72          throws SystemException, IOException {
73  
74          return getVelocityEngine().mergeTemplate(
75              velocityTemplateId, velocityContext, writer);
76      }
77  
78      public static boolean mergeTemplate(
79              String velocityTemplateId, String velocityTemplateContent,
80              VelocityContext velocityContext, Writer writer)
81          throws SystemException, IOException {
82  
83          return getVelocityEngine().mergeTemplate(
84              velocityTemplateId, velocityTemplateContent, velocityContext,
85              writer);
86      }
87  
88      public static boolean resourceExists(String resource) {
89          return getVelocityEngine().resourceExists(resource);
90      }
91  
92      public void setVelocityEngine(VelocityEngine velocityEngine) {
93          _velocityEngine = velocityEngine;
94      }
95  
96      private static VelocityEngine _velocityEngine;
97  
98  }