Module java.xml

Package org.w3c.dom

API Note:
The documentation comments for the get and set methods within this API are written as property definitions and are shared between both methods. These methods do not follow the standard Java SE specification format.

Take the Node TextContent property as an example, both getTextContent and setTextContent shared the same content that defined the TextContent property itself.

Implementation Note:
The JDK implementation of LSSerializer follows the Characters section of the XML Specification in handling characters output. In particular, the specification defined a character range that excluded the surrogate blocks. As a result, the JDK LSSerializer writes characters in the surrogate blocks as Character References. Character 0xf0 0x9f 0x9a 0xa9 (Unicode code point U+1F6A9) for example will be written as 🚩.

This behavior is different from what was in the class description of LSSerializer. The relevant section is quoted below:

Within the character data of a document (outside of markup), any characters that cannot be represented directly are replaced with character references... Any characters that cannot be represented directly in the output character encoding are serialized as numeric character references

The JDK implementation does not follow this definition because it is not consistent with the XML Specification that defined an explicit character range with no association to the setting of the output character encoding.

  • Interface Summary
    Interface Description
    The Attr interface represents an attribute in an Element object.
    CDATA sections are used to escape blocks of text containing characters that would otherwise be regarded as markup.
    The CharacterData interface extends Node with a set of attributes and methods for accessing character data in the DOM.
    This interface inherits from CharacterData and represents the content of a comment, i.e., all the characters between the starting '<!--' and ending '-->'.
    The Document interface represents the entire HTML or XML document.
    DocumentFragment is a "lightweight" or "minimal" Document object.
    Each Document has a doctype attribute whose value is either null or a DocumentType object.
    The DOMConfiguration interface represents the configuration of a document and maintains a table of recognized parameters.
    DOMError is an interface that describes an error.
    DOMErrorHandler is a callback interface that the DOM implementation can call when reporting errors that happens while processing XML data, or when doing some other processing (e.g. validating a document).
    The DOMImplementation interface provides a number of methods for performing operations that are independent of any particular instance of the document object model.
    The DOMImplementationList interface provides the abstraction of an ordered collection of DOM implementations, without defining or constraining how this collection is implemented.
    This interface permits a DOM implementer to supply one or more implementations, based upon requested features and versions, as specified in DOM Features.
    DOMLocator is an interface that describes a location (e.g.
    The DOMStringList interface provides the abstraction of an ordered collection of DOMString values, without defining or constraining how this collection is implemented.
    The Element interface represents an element in an HTML or XML document.
    The ElementTraversal interface is a set of read-only attributes which allow an author to easily navigate between elements in a document.
    This interface represents a known entity, either parsed or unparsed, in an XML document.
    EntityReference nodes may be used to represent an entity reference in the tree.
    Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name.
    The NameList interface provides the abstraction of an ordered collection of parallel pairs of name and namespace values (which could be null values), without defining or constraining how this collection is implemented.
    The Node interface is the primary datatype for the entire Document Object Model.
    The NodeList interface provides the abstraction of an ordered collection of nodes, without defining or constraining how this collection is implemented.
    This interface represents a notation declared in the DTD.
    The ProcessingInstruction interface represents a "processing instruction", used in XML as a way to keep processor-specific information in the text of the document.
    The Text interface inherits from CharacterData and represents the textual content (termed character data in XML) of an Element or Attr.
    The TypeInfo interface represents a type referenced from Element or Attr nodes, specified in the schemas associated with the document.
    When associating an object to a key on a node using Node.setUserData() the application can provide a handler that gets called when the node the object is associated to is being cloned, imported, or renamed.
  • Exception Summary
    Exception Description
    DOM operations only raise exceptions in "exceptional" circumstances, i.e., when an operation is impossible to perform (either for logical reasons, because data is lost, or because the implementation has become unstable).