1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     3  *

     4  * This code is free software; you can redistribute it and/or modify it

     5  * under the terms of the GNU General Public License version 2 only, as

     6  * published by the Free Software Foundation.  Oracle designates this

     7  * particular file as subject to the "Classpath" exception as provided

     8  * by Oracle in the LICENSE file that accompanied this code.

     9  *

    10  * This code is distributed in the hope that it will be useful, but WITHOUT

    11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    13  * version 2 for more details (a copy is included in the LICENSE file that

    14  * accompanied this code).

    15  *

    16  * You should have received a copy of the GNU General Public License version

    17  * 2 along with this work; if not, write to the Free Software Foundation,

    18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    19  *

    20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    21  * or visit www.oracle.com if you need additional information or have any

    22  * questions.

    23  */

    24 

    25 /*

    26  * This file is available under and governed by the GNU General Public

    27  * License version 2 only, as published by the Free Software Foundation.

    28  * However, the following notice accompanied the original version of this

    29  * file and, per its terms, should not be removed:

    30  *

    31  * Copyright (c) 2004 World Wide Web Consortium,

    32  *

    33  * (Massachusetts Institute of Technology, European Research Consortium for

    34  * Informatics and Mathematics, Keio University). All Rights Reserved. This

    35  * work is distributed under the W3C(r) Software License [1] in the hope that

    36  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied

    37  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

    38  *

    39  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231

    40  */

    41 

    42 package org.w3c.dom;

    43 

    44 /**

    45  * CDATA sections are used to escape blocks of text containing characters that

    46  * would otherwise be regarded as markup. The only delimiter that is

    47  * recognized in a CDATA section is the "]]>" string that ends the CDATA

    48  * section. CDATA sections cannot be nested. Their primary purpose is for

    49  * including material such as XML fragments, without needing to escape all

    50  * the delimiters.

    51  * <p>The <code>CharacterData.data</code> attribute holds the text that is

    52  * contained by the CDATA section. Note that this <em>may</em> contain characters that need to be escaped outside of CDATA sections and

    53  * that, depending on the character encoding ("charset") chosen for

    54  * serialization, it may be impossible to write out some characters as part

    55  * of a CDATA section.

    56  * <p>The <code>CDATASection</code> interface inherits from the

    57  * <code>CharacterData</code> interface through the <code>Text</code>

    58  * interface. Adjacent <code>CDATASection</code> nodes are not merged by use

    59  * of the <code>normalize</code> method of the <code>Node</code> interface.

    60  * <p> No lexical check is done on the content of a CDATA section and it is

    61  * therefore possible to have the character sequence <code>"]]&gt;"</code>

    62  * in the content, which is illegal in a CDATA section per section 2.7 of [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>]. The

    63  * presence of this character sequence must generate a fatal error during

    64  * serialization or the cdata section must be splitted before the

    65  * serialization (see also the parameter <code>"split-cdata-sections"</code>

    66  * in the <code>DOMConfiguration</code> interface).

    67  * <p ><b>Note:</b> Because no markup is recognized within a

    68  * <code>CDATASection</code>, character numeric references cannot be used as

    69  * an escape mechanism when serializing. Therefore, action needs to be taken

    70  * when serializing a <code>CDATASection</code> with a character encoding

    71  * where some of the contained characters cannot be represented. Failure to

    72  * do so would not produce well-formed XML.

    73  * <p ><b>Note:</b> One potential solution in the serialization process is to

    74  * end the CDATA section before the character, output the character using a

    75  * character reference or entity reference, and open a new CDATA section for

    76  * any further characters in the text node. Note, however, that some code

    77  * conversion libraries at the time of writing do not return an error or

    78  * exception when a character is missing from the encoding, making the task

    79  * of ensuring that data is not corrupted on serialization more difficult.

    80  * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.

    81  */

    82 public interface CDATASection extends Text {

    83 }