1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.kernel.velocity;
16  
17  import java.io.Writer;
18  
19  /**
20   * <a href="VelocityEngine.java.html"><b><i>View Source</i></b></a>
21   *
22   * @author Raymond Augé
23   */
24  public interface VelocityEngine {
25  
26      public void flushTemplate(String resource);
27  
28      public VelocityContext getEmptyContext();
29  
30      public VelocityContext getRestrictedToolsContext();
31  
32      public VelocityContext getStandardToolsContext();
33  
34      public VelocityContext getWrappedRestrictedToolsContext();
35  
36      public VelocityContext getWrappedStandardToolsContext();
37  
38      public void init() throws Exception;
39  
40      public boolean mergeTemplate(
41              String velocityTemplateId, String velocityTemplateContent,
42              VelocityContext velocityContext, Writer writer)
43          throws Exception;
44  
45      public boolean mergeTemplate(
46              String velocityTemplateId, VelocityContext velocityContext,
47              Writer writer)
48          throws Exception;
49  
50      public boolean resourceExists(String resource);
51  
52  }