KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.apache.fulcrum.template;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2000-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, if
22  * any, must include the following acknowlegement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Velocity", and "Apache Software
29  * Foundation" must not be used to endorse or promote products derived
30  * from this software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * nor may "Apache" appear in their names without prior written
35  * permission of the Apache Group.
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.util.HashMap JavaDoc;
58
59 /**
60  * General purpose implemention of the application Context
61  * interface for general application use. This class should
62  * be used in place of the original Context class.
63  *
64  * This implementation uses a HashMap (@see java.util.HashMap )
65  * for data storage.
66  *
67  * This context implementation cannot be shared between threads
68  * without those threads synchronizing access between them, as
69  * the HashMap is not synchronized, nor are some of the fundamentals
70  * of AbstractContext. If you need to share a Context between
71  * threads with simultaneous access for some reason, please create
72  * your own and extend the interface Context
73  *
74  * @see org.apache.velocity.context.Context
75  *
76  * @author <a HREF="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
77  * @author <a HREF="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
78  * @author <a HREF="mailto:fedor.karpelevitch@home.com">Fedor Karpelevitch</a>
79  * @version $Id: DefaultTemplateContext.java,v 1.1 2004/11/12 10:26:06 epugh Exp $
80  */
81 public class DefaultTemplateContext
82     implements TemplateContext
83 {
84     TemplateContext innerContext;
85
86     /**
87      * storage for key/value pairs
88      */
89     private HashMap JavaDoc context = new HashMap JavaDoc();
90
91     /**
92      * default contructor, does nothing
93      * interesting
94      */
95     public DefaultTemplateContext()
96     {
97     }
98
99     /**
100      * Allow chained contexts.
101      */
102     public DefaultTemplateContext(TemplateContext context)
103     {
104         super();
105
106         //!! I realize this is not the most efficient
107 // way to do this, but I'm not sure if chained
108 // contexts can work with templating solutions
109 // other than velocity. I don't see why not right
110 // of the bat, but this will work for now.
111
112         Object JavaDoc[] keys = context.getKeys();
113
114         for (int i = 0; i < keys.length; i++)
115         {
116             put((String JavaDoc) keys[i], context.get((String JavaDoc)keys[i]));
117         }
118     }
119
120     public void put(String JavaDoc key, Object JavaDoc value)
121     {
122         context.put(key, value);
123     }
124
125     public Object JavaDoc get(String JavaDoc key)
126     {
127         return context.get(key);
128     }
129
130     public Object JavaDoc remove(Object JavaDoc key)
131     {
132         return context.remove(key);
133     }
134
135     public boolean containsKey(Object JavaDoc key)
136     {
137         return context.containsKey(key);
138     }
139
140     public Object JavaDoc[] getKeys()
141     {
142         return context.keySet().toArray();
143     }
144 }
145
146
Popular Tags