KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > dom > DeferredCDATASectionImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999-2002 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 com.sun.org.apache.xerces.internal.dom;
59
60 /**
61  * XML provides the CDATA markup to allow a region of text in which
62  * most of the XML delimiter recognition does not take place. This is
63  * intended to ease the task of quoting XML fragments and other
64  * programmatic information in a document's text without needing to
65  * escape these special characters. It's primarily a convenience feature
66  * for those who are hand-editing XML.
67  * <P>
68  * CDATASection is an Extended DOM feature, and is not used in HTML
69  * contexts.
70  * <P>
71  * Within the DOM, CDATASections are treated essentially as Text
72  * blocks. Their distinct type is retained in order to allow us to
73  * properly recreate the XML syntax when we write them out.
74  * <P>
75  * Reminder: CDATA IS NOT A COMPLETELY GENERAL SOLUTION; it can't
76  * quote its own end-of-block marking. If you need to write out a
77  * CDATA that contains the ]]> sequence, it's your responsibility to
78  * split that string over two successive CDATAs at that time.
79  * <P>
80  * CDATA does not participate in Element.normalize() processing.
81  *
82  * @version $Id: DeferredCDATASectionImpl.java,v 1.10 2002/01/29 01:15:07 lehors Exp $
83  * @since PR-DOM-Level-1-19980818.
84  */
85 public class DeferredCDATASectionImpl
86     extends CDATASectionImpl
87     implements DeferredNode {
88
89     //
90 // Constants
91 //
92
93     /** Serialization version. */
94     static final long serialVersionUID = 1983580632355645726L;
95
96     //
97 // Data
98 //
99
100     /** Node index. */
101     protected transient int fNodeIndex;
102
103     //
104 // Constructors
105 //
106
107     /**
108      * This is the deferred constructor. Only the fNodeIndex is given here. All other data,
109      * can be requested from the ownerDocument via the index.
110      */
111     DeferredCDATASectionImpl(DeferredDocumentImpl ownerDocument, int nodeIndex) {
112         super(ownerDocument, null);
113
114         fNodeIndex = nodeIndex;
115         needsSyncData(true);
116
117     } // <init>(DeferredDocumentImpl,int)
118
119     //
120 // DeferredNode methods
121 //
122
123     /** Returns the node index. */
124     public int getNodeIndex() {
125         return fNodeIndex;
126     }
127
128     //
129 // Protected methods
130 //
131
132     /** Synchronizes the data (name and value) for fast nodes. */
133     protected void synchronizeData() {
134
135         // no need to sync in the future
136 needsSyncData(false);
137
138         // fluff data
139 DeferredDocumentImpl ownerDocument =
140             (DeferredDocumentImpl) this.ownerDocument();
141         data = ownerDocument.getNodeValueString(fNodeIndex);
142
143     } // synchronizeData()
144
145 } // class DeferredCDATASectionImpl
146
Popular Tags