001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.velocity;
016    
017    import java.io.Writer;
018    
019    /**
020     * @author Raymond Aug??
021     */
022    public interface VelocityEngine {
023    
024            public void clearClassLoader(ClassLoader classLoader);
025    
026            public void flushTemplate(String velocityTemplateId);
027    
028            public VelocityContext getEmptyContext();
029    
030            public VelocityContext getRestrictedToolsContext();
031    
032            public VelocityContext getStandardToolsContext();
033    
034            public VelocityContext getWrappedClassLoaderToolsContext();
035    
036            public VelocityContext getWrappedRestrictedToolsContext();
037    
038            public VelocityContext getWrappedStandardToolsContext();
039    
040            public void init() throws Exception;
041    
042            public boolean mergeTemplate(
043                            String velocityTemplateId, String velocityTemplateContent,
044                            VelocityContext velocityContext, Writer writer)
045                    throws Exception;
046    
047            public boolean mergeTemplate(
048                            String velocityTemplateId, VelocityContext velocityContext,
049                            Writer writer)
050                    throws Exception;
051    
052            public boolean resourceExists(String resource);
053    
054    }