org.apache.xerces.dom.DeferredCDATASectionImpl Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.xerces.dom;
/**
* XML provides the CDATA markup to allow a region of text in which
* most of the XML delimiter recognition does not take place. This is
* intended to ease the task of quoting XML fragments and other
* programmatic information in a document's text without needing to
* escape these special characters. It's primarily a convenience feature
* for those who are hand-editing XML.
*
* CDATASection is an Extended DOM feature, and is not used in HTML
* contexts.
*
* Within the DOM, CDATASections are treated essentially as Text
* blocks. Their distinct type is retained in order to allow us to
* properly recreate the XML syntax when we write them out.
*
* Reminder: CDATA IS NOT A COMPLETELY GENERAL SOLUTION; it can't
* quote its own end-of-block marking. If you need to write out a
* CDATA that contains the ]]> sequence, it's your responsibility to
* split that string over two successive CDATAs at that time.
*
* CDATA does not participate in Element.normalize() processing.
*
* @xerces.internal
*
* @version $Id: DeferredCDATASectionImpl.java 447266 2006-09-18 05:57:49Z mrglavas $
* @since PR-DOM-Level-1-19980818.
*/
public class DeferredCDATASectionImpl
extends CDATASectionImpl
implements DeferredNode {
//
// Constants
//
/** Serialization version. */
static final long serialVersionUID = 1983580632355645726L;
//
// Data
//
/** Node index. */
protected transient int fNodeIndex;
//
// Constructors
//
/**
* This is the deferred constructor. Only the fNodeIndex is given here. All other data,
* can be requested from the ownerDocument via the index.
*/
DeferredCDATASectionImpl(DeferredDocumentImpl ownerDocument, int nodeIndex) {
super(ownerDocument, null);
fNodeIndex = nodeIndex;
needsSyncData(true);
} // (DeferredDocumentImpl,int)
//
// DeferredNode methods
//
/** Returns the node index. */
public int getNodeIndex() {
return fNodeIndex;
}
//
// Protected methods
//
/** Synchronizes the data (name and value) for fast nodes. */
protected void synchronizeData() {
// no need to sync in the future
needsSyncData(false);
// fluff data
DeferredDocumentImpl ownerDocument =
(DeferredDocumentImpl) this.ownerDocument();
data = ownerDocument.getNodeValueString(fNodeIndex);
} // synchronizeData()
} // class DeferredCDATASectionImpl