summaryrefslogtreecommitdiff
path: root/external/jaxp/source/gnu/xml/dom/DomPI.java
blob: 0b53042abd5caa1304bfa13326b2cce410f8aa7d (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * $Id: DomPI.java,v 1.1.1.1 2003-02-01 02:10:17 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: DomPI.java,v 1.1.1.1 2003-02-01 02:10:17 cbj Exp $

/**
 * <p> "ProcessingInstruction" (PI) implementation.
 * This is a non-core DOM class, supporting the "XML" feature. </p>
 *
 * <p> Unlike other DOM APIs in the "XML" feature, this one fully
 * exposes the functionality it describes.  So there is no reason
 * inherent in DOM to avoid using this API, unless you want to rely
 * on NOTATION declarations to associate meaning with your PIs;
 * there is no vendor-neutal way to record those notations in DOM.</p>
 *
 * <p> Also of note is that PI support is part of SAX, so that XML
 * systems using PIs can choose among multiple APIs. </p>
 *
 * @see DomNotation
 *
 * @author David Brownell 
 * @version $Date: 2003-02-01 02:10:17 $
 */
public class DomPI extends DomNode implements ProcessingInstruction
{
    private String	target;
    private String	data;


    /**
     * Constructs a ProcessingInstruction node associated with the
     * specified document, with the specified data.
     *
     * <p>This constructor should only be invoked by a Document object as
     * part of its createProcessingInstruction functionality, or through
     * a subclass which is similarly used in a "Sub-DOM" style layer. 
     */
    protected DomPI (Document owner, String target, String data)
    {
	super (owner);
	this.target = target;
	this.data = data;
    }


    /**
     * <b>DOM L1</b>
     * Returns the target of the processing instruction.
     */
    final public String getTarget ()
    {
	return target;
    }


    /**
     * <b>DOM L1</b>
     * Returns the target of the processing instruction
     * (same as getTarget).
     */
    final public String getNodeName ()
    {
	return target;
    }


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


    /**
     * <b>DOM L1</b>
     * Returns the data associated with the processing instruction.
     */
    final public String getData ()
    {
	return data;
    }


    /**
     * <b>DOM L1</b>
     * Returns the data associated with the processing instruction
     * (same as getData).
     */
    final public String getNodeValue ()
    {
	return data;
    }


    /**
     * <b>DOM L1</b>
     * Assigns the data associated with the processing instruction;
     * same as setNodeValue.
     */
    final public void setData (String data)
    {
	setNodeValue (data);
    }


    /**
     * <b>DOM L1</b>
     * Assigns the data associated with the processing instruction.
     */
    final public void setNodeValue (String data)
    {
	if (isReadonly ())
	    throw new DomEx (DomEx.NO_MODIFICATION_ALLOWED_ERR);
	this.data = data;
    }
}