KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fulcrum > velocity > ContextAdapter


1 package org.apache.fulcrum.velocity;
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 org.apache.fulcrum.template.TemplateContext;
58 import org.apache.velocity.context.AbstractContext;
59
60 /**
61  * An adapter for Fulcrum's {@link TemplateContext}. Allows for easy processing
62  * of TemplateContext objects by Velocity. This class extends
63  * {@link AbstractContext}, so it supports event cartridge handling.
64  *
65  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
66  * @author <a HREF="mailto:james@jamestaylor.org">James Taylor</a>
67  * @see org.apache.fulcrum.template.TemplateContext
68  * @see org.apache.velocity.context.Context
69  */

70 public class ContextAdapter extends AbstractContext
71 {
72     private TemplateContext context;
73
74     public ContextAdapter(TemplateContext context)
75     {
76         this.context = context;
77     }
78
79     /**
80      * @see AbstractContext#internalGet
81      */

82     public Object JavaDoc internalGet( String JavaDoc key )
83     {
84         return context.get( key );
85     }
86
87     /**
88      * @see AbstractContext#internalPut
89      */

90     public Object JavaDoc internalPut( String JavaDoc key, Object JavaDoc value )
91     {
92         context.put( key, value );
93
94         return null;
95     }
96
97     /**
98      * @see AbstractContext#internalContainsKey
99      */

100     public boolean internalContainsKey(Object JavaDoc key)
101     {
102         return context.containsKey( key );
103     }
104
105     /**
106      * @see AbstractContext#internalGetKeys
107      */

108     public Object JavaDoc[] internalGetKeys()
109     {
110         return context.getKeys();
111     }
112
113     /**
114      * @see AbstractContext#internalRemove
115      */

116     public Object JavaDoc internalRemove(Object JavaDoc key)
117     {
118         return context.remove( key );
119     }
120 }
121
Popular Tags