001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit.html;
039:
040: import java.io.PrintWriter;
041:
042: import com.gargoylesoftware.htmlunit.Page;
043:
044: /**
045: * Wrapper for the DOM node Comment.
046: *
047: * @version $Revision: 2132 $
048: * @author Karel Kolman
049: * @author Ahmed Ashour
050: */
051: public class DomComment extends DomCharacterData {
052:
053: private static final long serialVersionUID = -7728247579175928593L;
054:
055: /** the symbolic node name */
056: public static final String NODE_NAME = "#comment";
057:
058: /**
059: * Create an instance of DomComment
060: *
061: * @param page The Page that contains this element.
062: * @param data the string data held by this node
063: */
064: public DomComment(final Page page, final String data) {
065: super (page, data);
066: }
067:
068: /**
069: * @return the node type constant, in this case {@link org.w3c.dom.Node#COMMENT_NODE}
070: */
071: public short getNodeType() {
072: return org.w3c.dom.Node.COMMENT_NODE;
073: }
074:
075: /**
076: * @return the node name, in this case {@link #NODE_NAME}
077: */
078: public String getNodeName() {
079: return NODE_NAME;
080: }
081:
082: /**
083: * {@inheritDoc}
084: */
085: public String asText() {
086: return "";
087: }
088:
089: /**
090: * recursively write the XML data for the node tree starting at <code>node</code>
091: *
092: * @param indent white space to indent child nodes
093: * @param printWriter writer where child nodes are written
094: */
095: protected void printXml(final String indent,
096: final PrintWriter printWriter) {
097: printWriter.print(indent);
098: printWriter.print("<!--");
099: printWriter.print(getData());
100: printWriter.print("-->");
101: printChildrenAsXml(indent, printWriter);
102: }
103:
104: /**
105: * Gives a simple representation to facilitate debugging
106: * @return a simple representation
107: */
108: public String toString() {
109: return asXml();
110: }
111: }
|