1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2005 Tim Pizey
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 Pizey <timp AT paneris.org>
42 * http://paneris.org/~timp
43 */
44 package org.melati.template;
45
46 import java.util.Map;
47
48
49
50 /**
51 * A Context for use by a {@link TemplateEngine} to expand a {@link Template}
52 * against.
53 *
54 * @see ServletTemplateContext
55 */
56 public interface TemplateContext {
57
58 /**
59 * Put an object into the Context with a key.
60 *
61 * @param key the key
62 * @param value the object
63 */
64 Object put(String key, Object value);
65
66 /**
67 * Get an object from the Context by key.
68 *
69 * @param s key
70 * @return value
71 */
72 Object get(String s);
73
74 /**
75 * Return the Context itself, as an Object.
76 *
77 * @return the Context
78 */
79 Object getContext();
80
81 /**
82 * Set the current exception handling style.
83 */
84 void setPassbackExceptionHandling();
85
86 /**
87 * Set the current exception handling style.
88 */
89 void setPropagateExceptionHandling();
90
91 /** Load from a Map */
92 void putAll(Map<String, ?> m);
93 }
94