1 /* DomComment.java --
2    Copyright (C) 1999,2000,2001,2004 Free Software Foundation, Inc.
3 
4 This file is part of GNU Classpath.
5 
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10 
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 General Public License for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING.  If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
20 
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library.  Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
25 
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module.  An independent module is a module which is not derived from
33 or based on this library.  If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so.  If you do not wish to do so, delete this
36 exception statement from your version. */
37 
38 package gnu.xml.dom;
39 
40 import org.w3c.dom.Comment;
41 
42 /**
43  * <p> "Comment" implementation.
44  * Comments hold data intended for direct consumption by people;
45  * programs should only use ProcessingInstruction nodes.  Note that
46  * since SAX makes comment reporting optional, XML systems that
47  * rely on comments (such as by using this class) will often lose
48  * those comments at some point in the processing pipeline. </p>
49  *
50  * @author David Brownell
51  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
52  */
53 public class DomComment
54   extends DomCharacterData
55   implements Comment
56 {
57 
58   /**
59    * Constructs a comment node associated with the specified
60    * document and holding the specified data.
61    *
62    * <p>This constructor should only be invoked by a Document as part of
63    * its createComment functionality, or through a subclass which is
64    * similarly used in a "Sub-DOM" style layer.
65    */
DomComment(DomDocument owner, String value)66   protected DomComment(DomDocument owner, String value)
67   {
68     super(COMMENT_NODE, owner, value);
69   }
70 
71   /**
72    * <b>DOM L1</b>
73    * Returns the string "#comment".
74    */
getNodeName()75   final public String getNodeName()
76   {
77     return "#comment";
78   }
79 
80 }
81