KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > apache > xerces > dom > ProcessingInstructionImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.enhydra.apache.xerces.dom;
59
60 import org.w3c.dom.DOMException JavaDoc;
61 import org.w3c.dom.Node JavaDoc;
62 import org.w3c.dom.ProcessingInstruction JavaDoc;
63
64 /**
65  * Processing Instructions (PIs) permit documents to carry
66  * processor-specific information alongside their actual content. PIs
67  * are most common in XML, but they are supported in HTML as well.
68  *
69  * This class inherits from CharacterDataImpl to reuse its setNodeValue method.
70  *
71  * @version
72  * @since PR-DOM-Level-1-19980818.
73  */
74 public class ProcessingInstructionImpl
75     extends CharacterDataImpl
76     implements ProcessingInstruction JavaDoc {
77
78     //
79 // Constants
80 //
81
82     /** Serialization version. */
83     static final long serialVersionUID = 7554435174099981510L;
84
85     //
86 // Data
87 //
88
89     protected String JavaDoc target;
90
91     //
92 // Constructors
93 //
94
95     /** Factory constructor. */
96     public ProcessingInstructionImpl(CoreDocumentImpl ownerDoc,
97                                      String JavaDoc target, String JavaDoc data) {
98         super(ownerDoc, data);
99         this.target = target;
100     }
101
102     //
103 // Node methods
104 //
105
106     /**
107      * A short integer indicating what type of node this is. The named
108      * constants for this value are defined in the org.w3c.dom.Node interface.
109      */
110     public short getNodeType() {
111         return Node.PROCESSING_INSTRUCTION_NODE;
112     }
113
114     /**
115      * Returns the target
116      */
117     public String JavaDoc getNodeName() {
118         if (needsSyncData()) {
119             synchronizeData();
120         }
121         return target;
122     }
123
124     //
125 // ProcessingInstruction methods
126 //
127
128     /**
129      * A PI's "target" states what processor channel the PI's data
130      * should be directed to. It is defined differently in HTML and XML.
131      * <p>
132      * In XML, a PI's "target" is the first (whitespace-delimited) token
133      * following the "<?" token that begins the PI.
134      * <p>
135      * In HTML, target is always null.
136      * <p>
137      * Note that getNodeName is aliased to getTarget.
138      */
139     public String JavaDoc getTarget() {
140         if (needsSyncData()) {
141             synchronizeData();
142         }
143         return target;
144
145     } // getTarget():String
146
147     /**
148      * A PI's data content tells the processor what we actually want it
149      * to do. It is defined slightly differently in HTML and XML.
150      * <p>
151      * In XML, the data begins with the non-whitespace character
152      * immediately after the target -- @see getTarget().
153      * <p>
154      * In HTML, the data begins with the character immediately after the
155      * "&lt;?" token that begins the PI.
156      * <p>
157      * Note that getNodeValue is aliased to getData
158      */
159     public String JavaDoc getData() {
160         if (needsSyncData()) {
161             synchronizeData();
162         }
163         return data;
164
165     } // getData():String
166
167     /**
168      * Change the data content of this PI.
169      * Note that setData is aliased to setNodeValue.
170      * @see #getData().
171      * @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is read-only.
172      */
173     public void setData(String JavaDoc data) {
174         // Hand off to setNodeValue for code-reuse reasons (mutation
175 // events, readonly protection, synchronizing, etc.)
176 setNodeValue(data);
177     } // setData(String)
178
179 } // class ProcessingInstructionImpl
180
Popular Tags