KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fulcrum > template > TurbineTemplate


1 package org.apache.fulcrum.template;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import java.io.OutputStream JavaDoc;
58 import java.io.Writer JavaDoc;
59 import org.apache.fulcrum.ServiceException;
60 import org.apache.fulcrum.TurbineServices;
61 import org.apache.fulcrum.template.TemplateContext;
62
63 /**
64  * This is a simple static accessor to common TemplateService tasks such as
65  * getting a Screen that is associated with a screen template.
66  *
67  * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally</a>
68  * @version $Id: TurbineTemplate.java,v 1.1 2004/11/12 10:26:06 epugh Exp $
69  */
70 public abstract class TurbineTemplate
71 {
72     /**
73      * Utility method for accessing the service
74      * implementation
75      *
76      * @return a TemplateService implementation instance
77      */
78     protected static TemplateService getService()
79     {
80         return (TemplateService)TurbineServices
81             .getInstance().getService(TemplateService.SERVICE_NAME);
82     }
83
84     public static final void registerTemplateEngineService(TemplateEngineService service)
85     {
86         getService().registerTemplateEngineService(service);
87     }
88
89     public static final String JavaDoc[] translateTemplatePaths(String JavaDoc[] templatePaths)
90     {
91         return getService().translateTemplatePaths(templatePaths);
92     }
93
94     public static final boolean templateExists(String JavaDoc template, String JavaDoc[] templatePaths)
95     {
96         return getService().templateExists(template, templatePaths);
97     }
98
99     public static final String JavaDoc handleRequest(TemplateContext context, String JavaDoc template)
100         throws ServiceException
101     {
102         return getService().handleRequest(context, template);
103     }
104
105     public static final void handleRequest(TemplateContext context,
106                                              String JavaDoc template,
107                                              OutputStream JavaDoc outputStream)
108         throws ServiceException
109     {
110         getService().handleRequest(context, template, outputStream);
111     }
112
113     public static final void handleRequest(TemplateContext context,
114                                            String JavaDoc template,
115                                            Writer JavaDoc writer)
116         throws ServiceException
117     {
118         getService().handleRequest(context, template, writer);
119     }
120
121     public static final TemplateContext getTemplateContext()
122     {
123         return getService().getTemplateContext();
124     }
125
126     public static final boolean templateExists(String JavaDoc template)
127     {
128         return getService().templateExists(template);
129     }
130 }
131
Popular Tags