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 java.io.Writer;
26  
27  /**
28   * <a href="VelocityEngineUtil.java.html"><b><i>View Source</i></b></a>
29   *
30   * @author Raymond Augé
31   */
32  public class VelocityEngineUtil {
33  
34      public static void flushTemplate(String resource) {
35          getVelocityEngine().flushTemplate(resource);
36      }
37  
38      public static VelocityContext getEmptyContext() {
39          return getVelocityEngine().getEmptyContext();
40      }
41  
42      public static VelocityContext getRestrictedToolsContext() {
43          return getVelocityEngine().getRestrictedToolsContext();
44      }
45  
46      public static VelocityContext getStandardToolsContext() {
47          return getVelocityEngine().getStandardToolsContext();
48      }
49  
50      public static VelocityEngine getVelocityEngine() {
51          return _velocityEngine;
52      }
53  
54      public static VelocityContext getWrappedRestrictedToolsContext() {
55          return getVelocityEngine().getWrappedRestrictedToolsContext();
56      }
57  
58      public static VelocityContext getWrappedStandardToolsContext() {
59          return getVelocityEngine().getWrappedStandardToolsContext();
60      }
61  
62      public static void init() throws Exception {
63          getVelocityEngine().init();
64      }
65  
66      public static boolean mergeTemplate(
67              String velocityTemplateId, String velocityTemplateContent,
68              VelocityContext velocityContext, Writer writer)
69          throws Exception {
70  
71          return getVelocityEngine().mergeTemplate(
72              velocityTemplateId, velocityTemplateContent, velocityContext,
73              writer);
74      }
75  
76      public static boolean mergeTemplate(
77              String velocityTemplateId, VelocityContext velocityContext,
78              Writer writer)
79          throws Exception {
80  
81          return getVelocityEngine().mergeTemplate(
82              velocityTemplateId, velocityContext, writer);
83      }
84  
85      public static boolean resourceExists(String resource) {
86          return getVelocityEngine().resourceExists(resource);
87      }
88  
89      public void setVelocityEngine(VelocityEngine velocityEngine) {
90          _velocityEngine = velocityEngine;
91      }
92  
93      private static VelocityEngine _velocityEngine;
94  
95  }