1 /*
2 * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/JellyContext.java,v 1.10 2002/04/26 12:20:12 jstrachan Exp $
3 * $Revision: 1.10 $
4 * $Date: 2002/04/26 12:20:12 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * $Id: JellyContext.java,v 1.10 2002/04/26 12:20:12 jstrachan Exp $
61 */
62
63 package org.apache.commons.jelly.task;
64
65 import java.util.HashMap;
66 import java.util.HashSet;
67 import java.util.Iterator;
68 import java.util.Map;
69
70 import org.apache.commons.jelly.JellyContext;
71
72 import org.apache.commons.logging.Log;
73 import org.apache.commons.logging.LogFactory;
74
75 import org.apache.tools.ant.Project;
76
77 /*** <p><code>AntJellyContext</code> represents the Jelly context from inside Ant.</p>
78 *
79 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
80 * @version $Revision: 1.10 $
81 */
82
83 public class AntJellyContext extends JellyContext {
84
85 /*** The Ant project which contains the variables */
86 private Project project;
87
88 /*** The Log to which logging calls will be made. */
89 private Log log = LogFactory.getLog(AntJellyContext.class);
90
91 public AntJellyContext(Project project, JellyContext parentJellyContext) {
92 super( parentJellyContext );
93 this.project = project;
94 }
95
96 /*** @return the value of the given variable name */
97 public Object getVariable(String name) {
98 // look in parent first
99 Object answer = super.getVariable(name);
100 if (answer == null) {
101 answer = project.getProperty(name);
102 }
103
104 if ( log.isDebugEnabled() ) {
105 log.debug( "Looking up variable: " + name + " answer: " + answer );
106 }
107
108 return answer;
109 }
110
111 /*** Sets the value of the given variable name */
112 public void setVariable(String name, Object value) {
113 if ( log.isDebugEnabled() ) {
114 log.debug( "Setting variable: " + name + " to: " + value );
115 }
116
117 super.setVariable( name, value );
118
119 // only export string values back to Ant?
120 if ( value instanceof String ) {
121 project.setProperty(name, (String) value);
122 }
123 }
124
125 /*** Removes the given variable */
126 public void removeVariable(String name) {
127 super.removeVariable( name );
128 project.setProperty(name, null);
129 }
130
131 /***
132 * @return an Iterator over the current variable names in this
133 * context
134 */
135 public Iterator getVariableNames() {
136 return getVariables().keySet().iterator();
137 }
138
139 /***
140 * @return the Map of variables in this scope
141 */
142 public Map getVariables() {
143 // we should add all the Project's properties
144 Map map = new HashMap( project.getProperties() );
145
146 // override any local properties
147 map.putAll( super.getVariables() );
148 return map;
149 }
150
151 /***
152 * Sets the Map of variables to use
153 */
154
155 public void setVariables(Map variables) {
156 super.setVariables(variables);
157
158 // export any Ant properties
159 for ( Iterator iter = variables.entrySet().iterator(); iter.hasNext(); ) {
160 Map.Entry entry = (Map.Entry) iter.next();
161 String key = (String) entry.getKey();
162 Object value = entry.getValue();
163 if ( value instanceof String ) {
164 project.setProperty(key, (String)value);
165 }
166 }
167 }
168
169
170 // Implementation methods
171 //-------------------------------------------------------------------------
172
173 /***
174 * Factory method to create a new child of this context
175 */
176 protected JellyContext createChildContext() {
177 return new AntJellyContext(project, this);
178 }
179
180 }
This page was automatically generated by Maven