KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > AssignmentInstruction


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.util.*;
57 import freemarker.template.TemplateException;
58
59 /**
60  * An instruction that contains one or more assignments
61  */

62 final class AssignmentInstruction extends TemplateElement {
63
64     private int scope;
65     private Expression namespaceExp;
66
67     AssignmentInstruction(int scope) {
68         this.scope = scope;
69         nestedElements = new ArrayList(1);
70     }
71
72     void addAssignment(Assignment ass) {
73         nestedElements.add(ass);
74     }
75     
76     void setNamespaceExp(Expression namespaceExp) {
77         this.namespaceExp = namespaceExp;
78         for (int i=0; i<nestedElements.size();i++) {
79             ((Assignment) nestedElements.get(i)).setNamespaceExp(namespaceExp);
80         }
81     }
82
83     void accept(Environment env) throws TemplateException, IOException JavaDoc {
84         for (int i = 0; i<nestedElements.size(); i++) {
85             Assignment ass = (Assignment) nestedElements.get(i);
86             env.visit(ass);
87         }
88     }
89
90     public String JavaDoc getCanonicalForm() {
91         String JavaDoc tag = "<#local ";
92         if (scope == Assignment.GLOBAL) {
93             tag = "<#global ";
94         }
95         else if (scope == Assignment.NAMESPACE) {
96             tag = "<#assign ";
97         }
98         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(tag);
99         for (int i = 0; i<nestedElements.size(); i++) {
100             Assignment ass = (Assignment) nestedElements.get(i);
101             buf.append(ass.getCanonicalForm());
102             if (i < nestedElements.size() -1) {
103                 buf.append(" ");
104             }
105         }
106         if (namespaceExp != null) {
107             buf.append(" in ");
108             buf.append(namespaceExp.getCanonicalForm());
109         }
110         buf.append("/>");
111         return buf.toString();
112     }
113
114     public String JavaDoc getDescription() {
115         String JavaDoc tag = "local ";
116         if (scope == Assignment.GLOBAL) {
117             tag = "global ";
118         }
119         else if (scope == Assignment.NAMESPACE) {
120             tag = "assign ";
121         }
122         tag += "assignment";
123         if (nestedElements.size() > 1) {
124             tag += "s";
125         }
126         return tag;
127     }
128
129     public TemplateElement postParseCleanup(boolean stripWhitespace) throws ParseException {
130         super.postParseCleanup(stripWhitespace);
131         if (nestedElements.size() == 1) {
132             Assignment ass = (Assignment) nestedElements.get(0);
133             ass.setLocation(getTemplate(), this, this);
134             return ass;
135         }
136         return this;
137     }
138 }
139
Popular Tags