Package org.jdom2.input

Class SAXBuilder

java.lang.Object
org.jdom2.input.SAXBuilder
All Implemented Interfaces:
SAXEngine
public class SAXBuilder extends Object implements SAXEngine
Builds a JDOM Document using a SAX parser.

SAXbuilder uses a third-party SAX parser (chosen by JAXP by default, or you can configure it manually) to handle the parsing duties and uses an instance of a SAXHandler to listen to the SAX events in order to construct a document with JDOM content using a JDOMFactory. Information about SAX can be found at http://www.saxproject.org.

For a complete description of how SAXBuilder is used, and how to customise the process you should look at the org.jdom2.input.sax package documentation.

JDOM users needing to customise the SAX parsing process have traditionally sub-classed this SAXBuilder class. In JDOM2 this should never be necessary. Please read the full documentation of this class, SAXHandler, SAXHandlerFactory, JDOMFactory, and the package documentation for org.jdom2.input.sax before overriding this class. Future versions of JDOM2 may make this class 'final'. I you feel you have a good reason to subclass SAXBuilder please mention it on jdom-interest mailing list so that SAXBuilder can be extended or adapted to handle your use-case.

Neither SAXBuilder nor anything derived from SAXBuilder is thread-safe. You must ensure that SAXBuilder is used in a single thread, or that sufficient locking is in place to ensure that SAXBuilder is not concurrently accessed. See the special note on buildEngine().

Known issues:

  • Relative paths for a DocType or EntityRef may be converted by the SAX parser into absolute paths.
  • SAX does not recognise whitespace character content outside the root element (nor does JDOM) so any formatting outside the root Element will be lost.
Author:
Jason Hunter, Brett McLaughlin, Dan Schaffer, Philip Nelson, Alex Rosen, Rolf Lear
See Also:

  • Constructor Details

  • Method Details

    • getDriverClass

      @Deprecated public String getDriverClass()
      Deprecated.
      as the driver class is only available in limited situations and anyway it had to be supplied in a constructor as either a direct value or as an XMLReaderSAX2Factory instance.
      Returns the driver class assigned in the constructor, or null if none. The driver class is only available if a SAX2 source was specified. This method is available for backward-compatibility with JDOM 1.x
      Returns:
      the driver class assigned in the constructor

    • getFactory

      @Deprecated public JDOMFactory getFactory()
      Deprecated.
      as it is replaced by getJDOMFactory()
      Returns the current JDOMFactory in use.
      Returns:
      the factory in use

    • getJDOMFactory

      public JDOMFactory getJDOMFactory()
      Returns the current JDOMFactory in use.
      Specified by:
      getJDOMFactory in interface SAXEngine
      Returns:
      the factory in use

    • setFactory

      @Deprecated public void setFactory(JDOMFactory factory)
      Deprecated.
      as it is replaced by setJDOMFactory(JDOMFactory)
      This sets a custom JDOMFactory for the builder. Use this to build the tree with your own subclasses of the JDOM classes.
      Parameters:
      factory - JDOMFactory to use

    • setJDOMFactory

      public void setJDOMFactory(JDOMFactory factory)
      This sets a custom JDOMFactory for the builder. Use this to build the tree with your own subclasses of the JDOM classes.
      Parameters:
      factory - JDOMFactory to use

    • getXMLReaderFactory

      public XMLReaderJDOMFactory getXMLReaderFactory()
      Get the current XMLReader factory.
      Returns:
      the current JDOMXMLReaderFactory

    • setXMLReaderFactory

      public void setXMLReaderFactory(XMLReaderJDOMFactory rfac)
      Set the current XMLReader factory.
      Parameters:
      rfac - the JDOMXMLReaderFactory to set. A null rfac will indicate the default XMLReaders.NONVALIDATING

    • getSAXHandlerFactory

      public SAXHandlerFactory getSAXHandlerFactory()
      Get the SAXHandlerFactory used to supply SAXHandlers to this SAXBuilder.
      Returns:
      the current SAXHandlerFactory (never null).

    • setSAXHandlerFactory

      public void setSAXHandlerFactory(SAXHandlerFactory factory)
      Set the SAXHandlerFactory to be used by this SAXBuilder.
      Parameters:
      factory - the required SAXHandlerFactory. A null input factory will request the DefaultSAXHandlerFactory.

    • getValidation

      @Deprecated public boolean getValidation()
      Deprecated.
      in lieu of isValidating()
      Returns whether validation is to be performed during the build.
      Returns:
      whether validation is to be performed during the build

    • isValidating

      public boolean isValidating()
      Returns whether validation is to be performed during the build.
      Specified by:
      isValidating in interface SAXEngine
      Returns:
      whether validation is to be performed during the build

    • setValidation

      @Deprecated public void setValidation(boolean validate)
      Deprecated.
      use setXMLReaderFactory(XMLReaderJDOMFactory)
      This sets validation for the builder.

      Do Not Use

      JDOM2 introduces the concept of XMLReader factories. The XMLReader is what determines the type of validation. A simple boolean is not enough to indicate what sort of validation is required. The setXMLReaderFactory(XMLReaderJDOMFactory) method provides a means to be more specific about validation.

      For backward compatibility this method has been retained, but its use is discouraged. It does make some logical choices though. The code is equivalent to: 

       setXMLReaderFactory(XMLReaders.DTDVALIDATING)
      for true, and 
       setXMLReaderFactory(XMLReaders.NONVALIDATING)
      for false.
      Parameters:
      validate - boolean indicating whether validation should occur.
      See Also:

    • getErrorHandler

      public ErrorHandler getErrorHandler()
      Returns the ErrorHandler assigned, or null if none. When the SAXBuilder parses a document it will always have an ErrorHandler but it will be an instance of BuilderErrorHandler unless you specify a different ErrorHandler in setErrorHandler(ErrorHandler). In other words, a null return value from here indicates a default will be used.
      Specified by:
      getErrorHandler in interface SAXEngine
      Returns:
      the ErrorHandler assigned, or null if SAXBuilder will create a default ErrorHandler when needed.

    • setErrorHandler

      public void setErrorHandler(ErrorHandler errorHandler)
      This sets custom ErrorHandler for the Builder. Setting a null value will indicate SAXBuilder should create a default ErrorHandler when needed.
      Parameters:
      errorHandler - ErrorHandler

    • getEntityResolver

      public EntityResolver getEntityResolver()
      Returns the EntityResolver assigned, or null if none.
      Specified by:
      getEntityResolver in interface SAXEngine
      Returns:
      the EntityResolver assigned

    • setEntityResolver

      public void setEntityResolver(EntityResolver entityResolver)
      This sets custom EntityResolver for the Builder.
      Parameters:
      entityResolver - EntityResolver

    • getDTDHandler

      public DTDHandler getDTDHandler()
      Returns the DTDHandler assigned, or null if the assigned SAXHandler will be used for DTD SAX events.
      Specified by:
      getDTDHandler in interface SAXEngine
      Returns:
      the DTDHandler assigned

    • setDTDHandler

      public void setDTDHandler(DTDHandler dtdHandler)
      This sets custom DTDHandler for the Builder. Setting a null value indicates that SAXBuilder should use the assigned SAXHandler for DTD processing.
      Parameters:
      dtdHandler - DTDHandler

    • getXMLFilter

      public XMLFilter getXMLFilter()
      Returns the XMLFilter used during parsing, or null if none.
      Returns:
      the XMLFilter used during parsing

    • setXMLFilter

      public void setXMLFilter(XMLFilter xmlFilter)
      This sets a custom XMLFilter for the builder.

      Care should be taken to ensure that the specified xmlFilter is reentrant and thread-safe.

      SAXBuilder will set this instance as the parent instance for all XMLReaders that may be created, and these may (depending on SAXBuilder usage) be accessed concurrently. It is the responsibility of the JDOM user to ensure that if the XMLFilter is not thread-safe then neither the SAXBuilder nor any of its SAXEngines are accessed concurrently.

      Parameters:
      xmlFilter - the XMLFilter to use

    • getIgnoringElementContentWhitespace

      public boolean getIgnoringElementContentWhitespace()
      Returns whether element content whitespace is to be ignored during the build.
      Specified by:
      getIgnoringElementContentWhitespace in interface SAXEngine
      Returns:
      whether element content whitespace is to be ignored during the build

    • setIgnoringElementContentWhitespace

      public void setIgnoringElementContentWhitespace(boolean ignoringWhite)
      Specifies whether or not the parser should eliminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. Only whitespace which is contained within element content that has an element only content model will be eliminated (see XML Rec 3.2.1). For this setting to take effect requires that validation be turned on. The default value of this setting is false.
      Parameters:
      ignoringWhite - Whether to ignore ignorable whitespace

    • getIgnoringBoundaryWhitespace

      public boolean getIgnoringBoundaryWhitespace()
      Returns whether or not the parser will eliminate element content containing only whitespace.
      Specified by:
      getIgnoringBoundaryWhitespace in interface SAXEngine
      Returns:
      boolean - whether only whitespace content will be ignored during build.
      See Also:

    • setIgnoringBoundaryWhitespace

      public void setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite)
      Specifies whether or not the parser should eliminate boundary whitespace, a term that indicates whitespace-only text between element tags. This feature is a lot like setIgnoringElementContentWhitespace(boolean) but this feature is more aggressive and doesn't require validation be turned on. The setIgnoringElementContentWhitespace(boolean) call impacts the SAX parse process while this method impacts the JDOM build process, so it can be beneficial to turn both on for efficiency. For implementation efficiency, this method actually removes all whitespace-only text() nodes. That can, in some cases (like between an element tag and a comment) include whitespace that isn't just boundary whitespace. The default is false.
      Parameters:
      ignoringBoundaryWhite - Whether to ignore whitespace-only text nodes

    • getExpandEntities

      public boolean getExpandEntities()
      Returns whether or not entities are being expanded into normal text content.
      Specified by:
      getExpandEntities in interface SAXEngine
      Returns:
      whether entities are being expanded

    • setExpandEntities

      public void setExpandEntities(boolean expand)

      This sets whether or not to expand entities for the builder. A true means to expand entities as normal content. A false means to leave entities unexpanded as EntityRef objects. The default is true.

      When this setting is false, the internal DTD subset is retained; when this setting is true, the internal DTD subset is not retained.

      Note that Xerces (at least up to 1.4.4) has a bug where entities in attribute values will be incorrectly reported if this flag is turned off, resulting in entities appearing within element content. When turning entity expansion off either avoid entities in attribute values, or use another parser like Crimson. http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6111

      Parameters:
      expand - boolean indicating whether entity expansion should occur.

    • getReuseParser

      public boolean getReuseParser()
      Returns whether the contained SAX parser instance is reused across multiple parses. The default is true.
      Returns:
      whether the contained SAX parser instance is reused across multiple parses

    • setReuseParser

      public void setReuseParser(boolean reuseParser)
      Specifies whether this builder will reuse the same SAX parser when performing subsequent parses or allocate a new parser for each parse. The default value of this setting is true (parser reuse).

      Note: SAX parser instances are not thread safe (they are not even reentrant), and nor are SAXBuilder instances. Setting parser reuse does not imply the parser is thread-safe.

      Parameters:
      reuseParser - Whether to reuse the SAX parser.

    • setFastReconfigure

      @Deprecated public void setFastReconfigure(boolean fastReconfigure)
      Deprecated.
      All reused Parsers are now fast-reconfigured. No need to set it.
      Specifies whether this builder will do fast reconfiguration of the underlying SAX parser when reuseParser is true. This improves performance in cases where SAXBuilders are reused and lots of small documents are frequently parsed. This avoids attempting to set features on the SAX parser each time build() is called which result in SaxNotRecognizedExceptions. This should ONLY be set for builders where this specific case is an issue. The default value of this setting is false (no fast reconfiguration). If reuseParser is false, calling this has no effect.
      Parameters:
      fastReconfigure - Whether to do a fast reconfiguration of the parser

    • setFeature

      public void setFeature(String name, boolean value)
      This sets a feature on the SAX parser. See the SAX documentation for more information.

      NOTE: SAXBuilder requires that some particular features of the SAX parser be set up in certain ways for it to work properly. The list of such features may change in the future. Therefore, the use of this method may cause parsing to break, and even if it doesn't break anything today it might break parsing in a future JDOM version, because what JDOM parsers require may change over time. Use with caution.

      JDOM uses XMLReaderJDOMFactory instances to provide XMLReader instances. If you require special configuration on your XMLReader you should consider extending or implementing an XMLReaderJDOMFactory in the org.jdom2.input.sax package.
      Parameters:
      name - The feature name, which is a fully-qualified URI.
      value - The requested state of the feature (true or false).

    • setProperty

      public void setProperty(String name, Object value)
      This sets a property on the SAX parser. See the SAX documentation for more information.

      NOTE: SAXBuilder requires that some particular properties of the SAX parser be set up in certain ways for it to work properly. The list of such properties may change in the future. Therefore, the use of this method may cause parsing to break, and even if it doesn't break anything today it might break parsing in a future JDOM version, because what JDOM parsers require may change over time. Use with caution.

      JDOM uses XMLReaderJDOMFactory instances to provide XMLReader instances. If you require special configuration on your XMLReader you should consider extending or implementing an XMLReaderJDOMFactory in the org.jdom2.input.sax package.
      Parameters:
      name - The property name, which is a fully-qualified URI.
      value - The requested value for the property.

    • buildEngine

      public SAXEngine buildEngine() throws JDOMException
      This method builds a new and reusable SAXEngine. Each time this method is called a new instance of a SAXEngine will be returned.

      This method is used internally by the various SAXBuilder.build(*) methods (if any configuration has changed) but can also be used as a mechanism for creating SAXEngines to be used in parsing pools or other optimised structures.

      Returns:
      a SAXEngine representing the current state of the current SAXBuilder settings.
      Throws:
      JDOMException - if there is any problem initialising the engine.

    • createParser

      protected XMLReader createParser() throws JDOMException
      Allow overriding classes access to the Parser before it is used in a SAXBuilderEngine.
      Returns:
      a XMLReader parser.
      Throws:
      JDOMException - if there is a problem

    • configureParser

      protected void configureParser(XMLReader parser, SAXHandler contentHandler) throws JDOMException
      This configures the XMLReader to be used for reading the XML document.

      The default implementation sets various options on the given XMLReader, such as validation, DTD resolution, entity handlers, etc., according to the options that were set (e.g. via setEntityResolver) and set various SAX properties and features that are required for JDOM internals. These features may change in future releases, so change this behavior at your own risk.

      Parameters:
      parser - the XMLReader to configure.
      contentHandler - The SAXHandler to use for the XMLReader
      Throws:
      JDOMException - if configuration fails.

    • build

      public Document build(InputSource in) throws JDOMException, IOException
      This builds a document from the supplied input source.
      Specified by:
      build in interface SAXEngine
      Parameters:
      in - InputSource to read from
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed

    • build

      public Document build(InputStream in) throws JDOMException, IOException

      This builds a document from the supplied input stream.

      Specified by:
      build in interface SAXEngine
      Parameters:
      in - InputStream to read from
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed.

    • build

      public Document build(File file) throws JDOMException, IOException

      This builds a document from the supplied filename.

      Specified by:
      build in interface SAXEngine
      Parameters:
      file - File to read from
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed

    • build

      public Document build(URL url) throws JDOMException, IOException

      This builds a document from the supplied URL.

      Specified by:
      build in interface SAXEngine
      Parameters:
      url - URL to read from.
      Returns:
      Document - resultant Document object.
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed.

    • build

      public Document build(InputStream in, String systemId) throws JDOMException, IOException

      This builds a document from the supplied input stream.

      Specified by:
      build in interface SAXEngine
      Parameters:
      in - InputStream to read from.
      systemId - base for resolving relative URIs
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed

    • build

      public Document build(Reader characterStream) throws JDOMException, IOException

      This builds a document from the supplied Reader. It's the programmer's responsibility to make sure the reader matches the encoding of the file. It's often easier and safer to use an InputStream rather than a Reader, and to let the parser auto-detect the encoding from the XML declaration.

      Specified by:
      build in interface SAXEngine
      Parameters:
      characterStream - Reader to read from
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed

    • build

      public Document build(Reader characterStream, String systemId) throws JDOMException, IOException

      This builds a document from the supplied Reader. It's the programmer's responsibility to make sure the reader matches the encoding of the file. It's often easier and safer to use an InputStream rather than a Reader, and to let the parser auto-detect the encoding from the XML declaration.

      Specified by:
      build in interface SAXEngine
      Parameters:
      characterStream - Reader to read from.
      systemId - base for resolving relative URIs
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed

    • build

      public Document build(String systemId) throws JDOMException, IOException

      This builds a document from the supplied URI. The URI is typically a file name, or a URL. Do not use this method for parsing XML content that is in a Java String variable.

      • Right: ....build("path/to/file.xml");
      • Right: ....build("http://my.example.com/xmlfile");
      • Wrong: ....build("<root>datainvalid input: '&lt'/root>");

      If your XML content is in a Java String variable and you want to parse it, then use:
      ....build(new StringReader("<root>datainvalid input: '&lt'/root>"));

      Specified by:
      build in interface SAXEngine
      Parameters:
      systemId - URI for the input
      Returns:
      Document resultant Document object
      Throws:
      JDOMException - when errors occur in parsing
      IOException - when an I/O error prevents a document from being fully parsed