KickJava   Java API By Example, From Geeks To Geeks.

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


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, 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 /**
58  * A generic template context interface which can be employed to wrap
59  * and/or extend context classes from template engines plugged into
60  * Fulcrum.
61  *
62  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
63  */

64 public interface TemplateContext
65 {
66     /**
67      * Adds a name/value pair to the context.
68      *
69      * @param key The name to key the provided value with.
70      * @param value The corresponding value.
71      */

72     public void put(String JavaDoc key, Object JavaDoc value);
73
74     /**
75      * Gets the value corresponding to the provided key from the context.
76      *
77      * @param key The name of the desired value.
78      * @return The value corresponding to the provided key.
79      */

80     public Object JavaDoc get(String JavaDoc key);
81
82     /**
83      * Indicates whether the specified key is in the context.
84      *
85      * @param key The key to look for.
86      * @return Whether the key is in the context.
87      */

88     public boolean containsKey(Object JavaDoc key);
89
90     /**
91      * Get all the keys for the values in the context
92      */

93     public Object JavaDoc[] getKeys();
94
95     /**
96      * Removes the value associated with the specified key from the context.
97      *
98      * @param key The name of the value to remove.
99      * @return The value that the key was mapped to, or <code>null</code>
100      * if unmapped.
101      */

102     public Object JavaDoc remove(Object JavaDoc key);
103 }
104
Popular Tags