1 ////////////////////////////////////////////////////////////////////////////////
2 // MillScript: an Open Spice interpreter and batch website creation tool
3 // Copyright (C) 2001-2004 Open World Ltd
4 //
5 // This file is part of MillScript.
6 //
7 // MillScript is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU General Public License as published by the Free
9 // Software Foundation; either version 2 of the License, or (at your option)
10 // any later version.
11 //
12 // MillScript is distributed in the hope that it will be useful, but WITHOUT
13 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 // more details.
16 //
17 // You should have received a copy of the GNU General Public License along with
18 // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19 // Place, Suite 330, Boston, MA 02111-1307 USA
20 ////////////////////////////////////////////////////////////////////////////////
21 package org.millscript.millscript.datatypes;
22
23 import org.millscript.millscript.render.Renderable;
24 import org.millscript.millscript.render.Renderer;
25
26 import java.io.IOException;
27
28 /**
29 * An XmlComment is a lightweight object that plays the role of a comment in a
30 * XML document.
31 */
32 public final class XmlComment implements Fragment, Renderable {
33
34 /**
35 * The string contents of the XML comment.
36 */
37 private String text;
38
39 /**
40 * Constructs a new XML comment object, with the specified string contents.
41 *
42 * @param t the string contents of the XML comment
43 */
44 public XmlComment( final String t ) {
45 this.text = t;
46 }
47
48 /**
49 * @see org.millscript.millscript.render.Renderable#render(Renderer)
50 */
51 public void render( final Renderer r ) throws IOException {
52 r.renderXMLComment( this );
53 }
54
55 /**
56 * Returns the string contents of this XML comment.
57 *
58 * @return a String containing the contents of this XML comment
59 */
60 public String getText() {
61 return this.text;
62 }
63
64 /**
65 * @see java.lang.Object#toString()
66 */
67 @Override
68 public String toString() {
69 return "<!--" + this.text + "-->";
70 }
71
72 }