KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > BlockAssignment


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */

52
53 package freemarker.core;
54
55 import java.io.IOException JavaDoc;
56 import java.io.StringWriter JavaDoc;
57 import java.io.Writer JavaDoc;
58 import java.util.Map JavaDoc;
59
60 import freemarker.template.SimpleScalar;
61 import freemarker.template.TemplateException;
62 import freemarker.template.TemplateModel;
63 import freemarker.template.TemplateTransformModel;
64
65 /**
66  * @version $Id: BlockAssignment.java,v 1.4 2004/07/07 21:11:12 szegedia Exp $
67  */

68 final class BlockAssignment extends TemplateElement {
69
70     private final String JavaDoc varName;
71     private final Expression namespaceExp;
72     private final int scope;
73
74     BlockAssignment(TemplateElement nestedBlock, String JavaDoc varName, int scope, Expression namespaceExp) {
75         this.nestedBlock = nestedBlock;
76         this.varName = varName;
77         this.namespaceExp = namespaceExp;
78         this.scope = scope;
79     }
80
81     void accept(Environment env) throws TemplateException, IOException JavaDoc {
82         if (nestedBlock != null) {
83             env.visit(nestedBlock, new CaptureOutput(env), null);
84         }
85     }
86
87     private class CaptureOutput implements TemplateTransformModel {
88         private final Environment env;
89         private final Environment.Namespace fnsModel;
90         
91         CaptureOutput(Environment env) throws TemplateException {
92             this.env = env;
93             TemplateModel nsModel = null;
94             if(namespaceExp != null) {
95                 nsModel = namespaceExp.getAsTemplateModel(env);
96                 if (!(nsModel instanceof Environment.Namespace)) {
97                     throw new TemplateException(
98                         "namespace parameter does not specify "
99                         + "a namespace. It is a "
100                         + nsModel.getClass().getName(), env);
101                 }
102             }
103             fnsModel = (Environment.Namespace )nsModel;
104         }
105         
106         public Writer JavaDoc getWriter(Writer JavaDoc out, Map JavaDoc args) {
107             return new StringWriter JavaDoc() {
108                 public void close() {
109                     SimpleScalar result = new SimpleScalar(toString());
110                     switch(scope) {
111                         case Assignment.NAMESPACE: {
112                             if(fnsModel != null) {
113                                 fnsModel.put(varName, result);
114                             }
115                             else {
116                                 env.setVariable(varName, result);
117                             }
118                             break;
119                         }
120                         case Assignment.LOCAL: {
121                             env.setLocalVariable(varName, result);
122                             break;
123                         }
124                         case Assignment.GLOBAL: {
125                             env.setGlobalVariable(varName, result);
126                             break;
127                         }
128                     }
129                 }
130             };
131         }
132     }
133     
134     public String JavaDoc getCanonicalForm() {
135         String JavaDoc key;
136         switch(scope) {
137             case Assignment.LOCAL: {
138                 key = "local";
139                 break;
140             }
141             case Assignment.GLOBAL: {
142                 key = "global";
143                 break;
144             }
145             default: {
146                 key = "assign";
147                 break;
148             }
149         }
150         return "<#" + key + " " + varName +
151             (namespaceExp != null ? " in " + namespaceExp.getCanonicalForm() : "")
152             + ">" + nestedBlock.getCanonicalForm() + "</#" + key + ">";
153     }
154
155     public String JavaDoc getDescription() {
156         return "block assignment to variable: " + varName;
157     }
158
159     boolean isIgnorable() {
160         return false;
161     }
162 }
163
164
Popular Tags