summaryrefslogtreecommitdiff
path: root/external/jaxp/source/gnu/xml/dom/DomComment.java
blob: 5f0947b95b47961c3a6cb157aa8ad257306dc406 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * $Id: DomComment.java,v 1.1 2003-02-01 02:10:14 cbj Exp $
 * Copyright (C) 1999-2001 David Brownell
 * 
 * This file is part of GNU JAXP, a library.
 *
 * GNU JAXP is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * GNU JAXP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * As a special exception, if you link this library with other files to
 * produce an executable, this library does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * This exception does not however invalidate any other reasons why the
 * executable file might be covered by the GNU General Public License. 
 */

package gnu.xml.dom;

import org.w3c.dom.*;


// $Id: DomComment.java,v 1.1 2003-02-01 02:10:14 cbj Exp $

/**
 * <p> "Comment" implementation.
 * Comments hold data intended for direct consumption by people;
 * programs should only use ProcessingInstruction nodes.  Note that
 * since SAX makes comment reporting optional, XML systems that
 * rely on comments (such as by using this class) will often lose
 * those comments at some point in the processing pipeline. </p>
 *
 * @author David Brownell
 * @version $Date: 2003-02-01 02:10:14 $
 */
public class DomComment extends DomCharacterData implements Comment
{
    /**
     * Constructs a comment node associated with the specified
     * document and holding the specified data.
     *
     * <p>This constructor should only be invoked by a Document as part of
     * its createComment functionality, or through a subclass which is
     * similarly used in a "Sub-DOM" style layer.
     */
    protected DomComment (Document owner, String value)
    {
	super (owner, value);
    }


    /**
     * <b>DOM L1</b>
     * Returns the string "#comment".
     */
    final public String getNodeName ()
    {
	return "#comment";
    }

    /**
     * <b>DOM L1</b>
     * Returns the constant COMMENT_NODE.
     */
    final public short getNodeType ()
	{ return COMMENT_NODE; }
}