View Javadoc

1   /*
2    * $Id: TemplateEngine.java,v 1.3 2004/04/19 07:29:43 cpoirier Exp $version Mar 8, 2004 2:08:49 AM $user Exp $
3    * 
4    * Copyright 2003 (C) Sam Pullara. All Rights Reserved.
5    * 
6    * Redistribution and use of this software and associated documentation
7    * ("Software"), with or without modification, are permitted provided that the
8    * following conditions are met: 1. Redistributions of source code must retain
9    * copyright statements and notices. Redistributions must also contain a copy
10   * of this document. 2. Redistributions in binary form must reproduce the above
11   * copyright notice, this list of conditions and the following disclaimer in
12   * the documentation and/or other materials provided with the distribution. 3.
13   * The name "groovy" must not be used to endorse or promote products derived
14   * from this Software without prior written permission of The Codehaus. For
15   * written permission, please contact info@codehaus.org. 4. Products derived
16   * from this Software may not be called "groovy" nor may "groovy" appear in
17   * their names without prior written permission of The Codehaus. "groovy" is a
18   * registered trademark of The Codehaus. 5. Due credit should be given to The
19   * Codehaus - http://groovy.codehaus.org/
20   * 
21   * THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS ``AS IS'' AND ANY
22   * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24   * DISCLAIMED. IN NO EVENT SHALL THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR
25   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31   * DAMAGE.
32   *  
33   */
34  package groovy.text;
35  
36  import java.io.File;
37  import java.io.FileNotFoundException;
38  import java.io.FileReader;
39  import java.io.IOException;
40  import java.io.InputStreamReader;
41  import java.io.Reader;
42  import java.io.StringReader;
43  import java.net.URL;
44  
45  import org.codehaus.groovy.control.CompilationFailedException;
46  
47  /***
48   * Represents an API to any template engine which is basically a factory of Template instances from a given text input.
49   * 
50   * @author sam
51   */
52  public abstract class TemplateEngine {
53      public abstract Template createTemplate(Reader reader) throws CompilationFailedException, ClassNotFoundException, IOException;
54      
55      public Template createTemplate(String templateText) throws CompilationFailedException, FileNotFoundException, ClassNotFoundException, IOException {
56          return createTemplate(new StringReader(templateText));
57      }
58      
59      public Template createTemplate(File file) throws CompilationFailedException, FileNotFoundException, ClassNotFoundException, IOException {
60          return createTemplate(new FileReader(file));
61      }
62  
63      public Template createTemplate(URL url) throws CompilationFailedException, ClassNotFoundException, IOException {
64          return createTemplate(new InputStreamReader(url.openStream()));
65      }
66  }