01: /*
02: * Copyright (c) 2003 The Visigoth Software Society. All rights
03: * reserved.
04: *
05: * Redistribution and use in source and binary forms, with or without
06: * modification, are permitted provided that the following conditions
07: * are met:
08: *
09: * 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: /**
56: * A template element where the content is ignored, a Comment.
57: */
58: public final class Comment extends TemplateElement {
59:
60: private final String text;
61:
62: Comment(String text) {
63: this .text = text;
64: }
65:
66: void accept(Environment env) {
67: // do nothing, skip the body
68: }
69:
70: public String getCanonicalForm() {
71: return "<#--" + text + "-->";
72: }
73:
74: public String getDescription() {
75: String s = text.trim();
76: if (s.length() > 20) {
77: s = s.substring(0, 20) + "...";
78: }
79: return "comment (" + s + ")";
80: }
81:
82: public String getText() {
83: return text;
84: }
85: }
|