API Docs for SAX and DOM

 

Javadoc Generated Documentation

 

XML4J comes packaged with API documentation for SAX and DOM, the two most common interfaces for programming XML.  In addition, we provide documentation for classes that are not part of the SAX and DOM API's, but are useful for writing XML4J programs. 

This documentation is generated automatically from the Javadoc-style comments inside the source files.  Click on one of the links below to go to the appropriate API documentation.

Standard parser API (including Standard DOM) documentation

TX Compatibility DOM documentation

For more information on the differences between Standard DOM and the TX-Compatibility DOM implementations, see the FAQ on this topic.

XML4J Packages

 

com.ibm.xml.parsers

 

Classes

  • DOMParser
    DOM parser
  • NonValidatingDOMParser
    Non-validating DOM parser
  • NonValidatingParser
    Non-validating base parser
  • NonValidatingTXDOMParser
    Non-validating TX DOM parser
  • RevalidatingDOMParser
    Validating DOM parser which can also "revalidate" a DOM subtree after the document has been parsed
  • SAXParser
    SAX parser
  • TXDOMParser
    TX DOM parser
  • TXRevalidatingDOMParser
    Validating TX DOM parser which can also "revalidate" a TX DOM subtree after the document has been parsed
  • ValidatingParser
    Validating base parser
  • ValidatingSAXParser
    SAX parser with validating capabilities

org.wc3.dom

 

Interfaces

  • Attr
    The Attr interface represents an attribute in an Element object
  • CDATASection
    CDATA sections are used to escape blocks of text containing characters that would otherwise be regarded as markup
  • CharacterData
    The CharacterData interface extends Node with a set of attributes and methods for accessing character data in the DOM
  • Comment
    This represents the content of a comment
  • Document
    The Document interface represents the entire HTML or XML document
  • DocumentFragment
    DocumentFragment is a "lightweight" or "minimal" Document object
  • DocumentType
    Each Document has a doctype attribute whose value is either null or a DocumentType object
  • DOMImplementation
    The DOMImplementation interface provides  methods for performing operations independent of a particular document object model instance
  • Element
    The majority of objects (apart from text) in a document are Element nodes
  • Entity
    This interface represents an entity, either parsed or unparsed, in a XML document
  • EntityReference
    EntityReference objects may be inserted into the structure model
  • NamedNodeMap
    Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name
  • Node
    The Node interface is the primary datatype for the entire Document Object Model
  • NodeList
    The NodeList interface provides the abstraction of an ordered collection of nodes
  • Notation
    This interface represents a notation declared in the DTD
  • ProcessingInstruction
    The ProcessingInstruction is a way to keep processor-specific information in the text of the document
  • Text
    The Text interface represents the textual content (termed character data in XML) of an Element or Attr

Exception 

  • DOMException
    Encapsulate an "exceptional" DOM error message

org.xml.sax

 

Interfaces

  • AttributeList
    Interface for an element's attribute specifications
  • DocumentHandler
    Receive notification of general document events
  • DTDHandler
    Receive notification of basic DTD-related events
  • EntityResolver
    Basic interface for resolving entities
  • ErrorHandler
    Basic interface for SAX error handlers
  • Locator
    Interface for associating a SAX event with a document location
  • Parser
    Basic interface for SAX (Simple API for XML) parsers

Classes

  • HandlerBase
    Default base class for handlers
  • InputSource
    A single input source for an XML entity

Exceptions 

  • SAXException
    Encapsulate a general SAX error or warning
  • SAXParseException
    Encapsulate an XML parse error or warning

org.xml.sax.helpers

 

Classes 

  • AttributeListImpl
    Convenience implementation for AttributeList
  • LocatorImpl
    Convenience implementation for Locator
  • ParserFactory
    Java-specific class for dynamically loading SAX parsers