KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > PropertySetting


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 freemarker.template.Template;
56 import freemarker.template.TemplateBooleanModel;
57 import freemarker.template.TemplateException;
58 import freemarker.template.TemplateModel;
59 import freemarker.template.TemplateNumberModel;
60 import freemarker.template.TemplateScalarModel;
61
62 /**
63  * An instruction that sets a property of the template rendering
64  * environment.
65  */
66 final class PropertySetting extends TemplateElement {
67
68     private final String JavaDoc key;
69     private final Expression value;
70
71     PropertySetting(String JavaDoc key, Expression value) {
72         this.key = key;
73         this.value = value;
74     }
75
76     void setLocation(Template template, int beginColumn, int beginLine, int endColumn, int endLine)
77     throws
78         ParseException
79     {
80         super.setLocation(template, beginColumn, beginLine, endColumn, endLine);
81         if (!key.equals(Configurable.LOCALE_KEY) &&
82             !key.equals(Configurable.NUMBER_FORMAT_KEY) &&
83             !key.equals(Configurable.TIME_FORMAT_KEY) &&
84             !key.equals(Configurable.DATE_FORMAT_KEY) &&
85             !key.equals(Configurable.DATETIME_FORMAT_KEY) &&
86             !key.equals(Configurable.TIME_ZONE_KEY) &&
87             !key.equals(Configurable.BOOLEAN_FORMAT_KEY) &&
88             !key.equals(Configurable.CLASSIC_COMPATIBLE_KEY) &&
89             !key.equals(Configurable.URL_ESCAPING_CHARSET_KEY))
90         {
91             throw new ParseException(
92                     "Error " + getStartLocation()
93                     + "\nInvalid setting name, or it is not allowed to change "
94                     + "the value of the setting with FTL: "
95                     + key,
96                     beginLine, beginColumn);
97         }
98     }
99
100     void accept(Environment env) throws TemplateException {
101         TemplateModel mval = value.getAsTemplateModel(env);
102         String JavaDoc strval;
103         if (mval instanceof TemplateScalarModel) {
104             strval = ((TemplateScalarModel) mval).getAsString();
105         } else if (mval instanceof TemplateBooleanModel) {
106             strval = ((TemplateBooleanModel) mval).getAsBoolean() ? "true" : "false";
107         } else if (mval instanceof TemplateNumberModel) {
108             strval = ((TemplateNumberModel) mval).getAsNumber().toString();
109         } else {
110             strval = value.getStringValue(env);
111         }
112         env.setSetting(key, strval);
113     }
114
115     public String JavaDoc getCanonicalForm() {
116         return "<#setting " + key + "=" + value.getCanonicalForm() + "/>";
117     }
118
119     public String JavaDoc getDescription() {
120         return "setting " + key + " set to " + "\"" + value + "\" "
121         + "[" + getStartLocation() + "]";
122     }
123 }
124
Popular Tags