libjava/org/w3c/dom/CDATASection.java

   1 /*\r
   2  * Copyright (c) 2000 World Wide Web Consortium,\r
   3  * (Massachusetts Institute of Technology, Institut National de\r
   4  * Recherche en Informatique et en Automatique, Keio University). All\r
   5  * Rights Reserved. This program is distributed under the W3C's Software\r
   6  * Intellectual Property License. This program is distributed in the\r
   7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even\r
   8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
   9  * PURPOSE.\r
  10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.\r
  11  */\r
  12 \r
  13 package org.w3c.dom;\r
  14 \r
  15 /**\r
  16  * CDATA sections are used to escape blocks of text containing characters that \r
  17  * would otherwise be regarded as markup. The only delimiter that is \r
  18  * recognized in a CDATA section is the "]]&gt;" string that ends the CDATA \r
  19  * section. CDATA sections cannot be nested. Their primary purpose is for \r
  20  * including material such as XML fragments, without needing to escape all \r
  21  * the delimiters.\r
  22  * <p>The <code>DOMString</code> attribute of the <code>Text</code> node holds \r
  23  * the text that is contained by the CDATA section. Note that this may \r
  24  * contain characters that need to be escaped outside of CDATA sections and \r
  25  * that, depending on the character encoding ("charset") chosen for \r
  26  * serialization, it may be impossible to write out some characters as part \r
  27  * of a CDATA section. \r
  28  * <p> The <code>CDATASection</code> interface inherits from the \r
  29  * <code>CharacterData</code> interface through the <code>Text</code> \r
  30  * interface. Adjacent <code>CDATASection</code> nodes are not merged by use \r
  31  * of the <code>normalize</code> method of the <code>Node</code> interface.\r
  32  * Because no markup is recognized within a <code>CDATASection</code>, \r
  33  * character numeric references cannot be used as an escape mechanism when \r
  34  * serializing. Therefore, action needs to be taken when serializing a \r
  35  * <code>CDATASection</code> with a character encoding where some of the \r
  36  * contained characters cannot be represented. Failure to do so would not \r
  37  * produce well-formed XML.One potential solution in the serialization \r
  38  * process is to end the CDATA section before the character, output the \r
  39  * character using a character reference or entity reference, and open a new \r
  40  * CDATA section for any further characters in the text node. Note, however, \r
  41  * that some code conversion libraries at the time of writing do not return \r
  42  * an error or exception when a character is missing from the encoding, \r
  43  * making the task of ensuring that data is not corrupted on serialization \r
  44  * more difficult.\r
  45  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.\r
  46  */\r
  47 public interface CDATASection extends Text {\r
  48 }\r