##### Coverage Report - org.melati.template.ServletTemplateEngine

Classes in this File | Line Coverage | Branch Coverage | Complexity
ServletTemplateEngine |
N/A | N/A
N/A | N/A
| 1.0;1

1 |  |
     /*
2 |  |
      * $Source: /usr/cvsroot/melati/melati/src/site/resources/withWebmacro/org.melati.template.ServletTemplateEngine.html,v $
3 |  |
      * $Revision: 1.1 $
4 |  |
      *
5 |  |
      * Copyright (C) 2000 Tim Joyce
6 |  |
      *
7 |  |
      * Part of Melati (http://melati.org), a framework for the rapid
8 |  |
      * development of clean, maintainable web applications.
9 |  |
      *
10 |  |
      * Melati is free software; Permission is granted to copy, distribute
11 |  |
      * and/or modify this software under the terms either:
12 |  |
      *
13 |  |
      * a) the GNU General Public License as published by the Free Software
14 |  |
      *    Foundation; either version 2 of the License, or (at your option)
15 |  |
      *    any later version,
16 |  |
      *
17 |  |
      *    or
18 |  |
      *
19 |  |
      * b) any version of the Melati Software License, as published
20 |  |
      *    at http://melati.org
21 |  |
      *
22 |  |
      * You should have received a copy of the GNU General Public License and
23 |  |
      * the Melati Software License along with this program;
24 |  |
      * if not, write to the Free Software Foundation, Inc.,
25 |  |
      * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 |  |
      * GNU General Public License and visit http://melati.org to obtain the
27 |  |
      * Melati Software License.
28 |  |
      *
29 |  |
      * Feel free to contact the Developers of Melati (http://melati.org),
30 |  |
      * if you would like to work out a different arrangement than the options
31 |  |
      * outlined here.  It is our intention to allow Melati to be used by as
32 |  |
      * wide an audience as possible.
33 |  |
      *
34 |  |
      * This program is distributed in the hope that it will be useful,
35 |  |
      * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 |  |
      * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37 |  |
      * GNU General Public License for more details.
38 |  |
      *
39 |  |
      * Contact details for copyright holder:
40 |  |
      *
41 |  |
      *     Tim Joyce <timj@paneris.org>
42 |  |
      *     http://paneris.org/
43 |  |
      *     68 Sandbanks Rd, Poole, Dorset. BH14 8BY. UK
44 |  |
      */
45 |  |
46 |  |
     package org.melati.template;
47 |  |
48 |  |
     import javax.servlet.http.HttpServletResponse;
49 |  |
     import javax.servlet.http.HttpServlet;
50 |  |
51 |  |
     import org.melati.Melati;
52 |  |
     import org.melati.MelatiConfig;
53 |  |
     import org.melati.util.MelatiWriter;
54 |  |
55 |  |
     /**
56 |  |
      * Interface for a Template engine for use with Melati and Servlets.
57 |  |
      */
58 |  |
     public interface ServletTemplateEngine extends TemplateEngine {
59 |  |
60 |  |
       /**
61 |  |
        * Construct a new Engine for use in a servlet environment.
62 |  |
        *
63 |  |
        * @see org.melati.servlet.TemplateServlet
64 |  |
        * @param melatiConfig a {@link MelatiConfig}
65 |  |
        * @param servlet the servlet we are within
66 |  |
        * @throws TemplateEngineException if any problem occurs with the engine
67 |  |
        */
68 |  |
       void init(MelatiConfig melatiConfig, HttpServlet servlet)
69 |  |
           throws TemplateEngineException;
70 |  |
71 |  |
       /**
72 |  |
        * Get a Writer which can write to Servlet output.
73 |  |
        *
74 |  |
        * @param response the <code>HttpServletResponse</code> that this
75 |  |
        *                 writer will be part of
76 |  |
        * @param buffered whether the writer should be buffered
77 |  |
        * @return a {@link MelatiWriter}
78 |  |
        *         appropriate for this engine.
79 |  |
        */
80 |  |
       MelatiWriter getServletWriter(HttpServletResponse response,
81 |  |
                                     boolean buffered);
82 |  |
83 |  |
       /**
84 |  |
        * Get the generic parameters for this engine.
85 |  |
        *
86 |  |
        * @param melati the {@link Melati}
87 |  |
        * @throws TemplateEngineException if any problem occurs with the engine
88 |  |
        * @return a {@link ServletTemplateContext}
89 |  |
        */
90 |  |
       ServletTemplateContext getServletTemplateContext(Melati melati)
91 |  |
           throws TemplateEngineException;
92 |  |
93 |  |
     }