KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > cache > ClassTemplateLoader


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */
52
53 package freemarker.cache;
54
55 import java.net.URL JavaDoc;
56
57 /**
58  * A {@link TemplateLoader} that uses streams reachable through
59  * {@link Class#getResourceAsStream(String)} as its source of templates.
60  * @author Attila Szegedi, szegedia at freemail dot hu
61  * @version $Id: ClassTemplateLoader.java,v 1.9 2004/03/25 21:18:28 ddekany Exp $
62  */
63 public class ClassTemplateLoader extends URLTemplateLoader
64 {
65     private final Class JavaDoc loaderClass;
66     private final String JavaDoc path;
67     
68     /**
69      * Creates a resource template cache that will use its own class to
70      * load the resources. It will use the base path of <code>"/"</code>.
71      * (But you hardly ever should use the default package as the template
72      * root, so probably you should do something like this:<br>
73      * <tt>new ClassTemplateLoader(SomeClass.class, "/templates")</tt>)
74      */
75     public ClassTemplateLoader()
76     {
77         this(ClassTemplateLoader.class);
78     }
79
80     /**
81      * Creates a resource template cache that will use the specified class
82      * to load the resources. It will use the base path of <code>""</code>
83      * meaning templates will be resolved relative to the class location,
84      * that is, relatively to the directory (package) of the class.
85      * (But you hardly ever want to store a Java class in the template root,
86      * so probably you should do something like this:<br>
87      * <tt>new ClassTemplateLoader(SomeClass.class, "/templates")</tt>)
88
89      * @param loaderClass the class whose
90      * {@link Class#getResource(String)} will be used to load the templates.
91      */
92     public ClassTemplateLoader(Class JavaDoc loaderClass)
93     {
94         this(loaderClass, "");
95     }
96
97     /**
98      * Creates a resource template cache that will use the specified class
99      * to load the resources. It will use the specified base path. A path
100      * that doesn't start with a slash (/) is a path relative to the path (package)
101      * of the current class. A path that starts with a slash is an absolute
102      * path starting from the classpath root. Path components should be
103      * separated by forward slashes independently of the separator character
104      * used by the underlying operating system.
105      * @param loaderClass the class whose
106      * {@link Class#getResource(String)} will be used to load the templates.
107      * @param path the base path to template resources.
108      */
109     public ClassTemplateLoader(Class JavaDoc loaderClass, String JavaDoc path)
110     {
111         if(loaderClass == null)
112         {
113             throw new IllegalArgumentException JavaDoc("loaderClass == null");
114         }
115         if(path == null)
116         {
117             throw new IllegalArgumentException JavaDoc("path == null");
118         }
119         
120         this.loaderClass = loaderClass;
121         this.path = canonicalizePrefix(path);
122     }
123
124     protected URL JavaDoc getURL(String JavaDoc name)
125     {
126         return loaderClass.getResource(path + name);
127     }
128 }
Popular Tags