1. /*
  2. * Copyright (c) 2004 World Wide Web Consortium,
  3. *
  4. * (Massachusetts Institute of Technology, European Research Consortium for
  5. * Informatics and Mathematics, Keio University). All Rights Reserved. This
  6. * work is distributed under the W3C(r) Software License [1] in the hope that
  7. * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
  8. * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  9. *
  10. * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
  11. */
  12. package org.w3c.dom;
  13. /**
  14. * CDATA sections are used to escape blocks of text containing characters that
  15. * would otherwise be regarded as markup. The only delimiter that is
  16. * recognized in a CDATA section is the "]]>" string that ends the CDATA
  17. * section. CDATA sections cannot be nested. Their primary purpose is for
  18. * including material such as XML fragments, without needing to escape all
  19. * the delimiters.
  20. * <p>The <code>CharacterData.data</code> attribute holds the text that is
  21. * contained by the CDATA section. Note that this <em>may</em> contain characters that need to be escaped outside of CDATA sections and
  22. * that, depending on the character encoding ("charset") chosen for
  23. * serialization, it may be impossible to write out some characters as part
  24. * of a CDATA section.
  25. * <p>The <code>CDATASection</code> interface inherits from the
  26. * <code>CharacterData</code> interface through the <code>Text</code>
  27. * interface. Adjacent <code>CDATASection</code> nodes are not merged by use
  28. * of the <code>normalize</code> method of the <code>Node</code> interface.
  29. * <p> No lexical check is done on the content of a CDATA section and it is
  30. * therefore possible to have the character sequence <code>"]]>"</code>
  31. * 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
  32. * presence of this character sequence must generate a fatal error during
  33. * serialization or the cdata section must be splitted before the
  34. * serialization (see also the parameter <code>"split-cdata-sections"</code>
  35. * in the <code>DOMConfiguration</code> interface).
  36. * <p ><b>Note:</b> Because no markup is recognized within a
  37. * <code>CDATASection</code>, character numeric references cannot be used as
  38. * an escape mechanism when serializing. Therefore, action needs to be taken
  39. * when serializing a <code>CDATASection</code> with a character encoding
  40. * where some of the contained characters cannot be represented. Failure to
  41. * do so would not produce well-formed XML.
  42. * <p ><b>Note:</b> One potential solution in the serialization process is to
  43. * end the CDATA section before the character, output the character using a
  44. * character reference or entity reference, and open a new CDATA section for
  45. * any further characters in the text node. Note, however, that some code
  46. * conversion libraries at the time of writing do not return an error or
  47. * exception when a character is missing from the encoding, making the task
  48. * of ensuring that data is not corrupted on serialization more difficult.
  49. * <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>.
  50. */
  51. public interface CDATASection extends Text {
  52. }