org.jdom.input
public class SAXBuilder extends Object
SAXBuilder
builds a JDOM tree using SAX.
Information about SAX can be found at
http://www.megginson.com/SAX.
Known issues: Relative paths for a DocType or EntityRef may be converted by the SAX parser into absolute paths
Version: $Revision: 1.64 $, $Date: 2002/02/26 04:10:33 $
Field Summary | |
---|---|
protected JDOMFactory | factory The factory for creating new JDOM objects |
Constructor Summary | |
---|---|
SAXBuilder() Creates a new SAXBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default SAX Drivers. | |
SAXBuilder(boolean validate) Creates a new SAXBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default SAX Drivers. | |
SAXBuilder(String saxDriverClass) Creates a new SAXBuilder using the specified SAX parser. | |
SAXBuilder(String saxDriverClass, boolean validate) Creates a new SAXBuilder using the specified SAX parser. |
Method Summary | |
---|---|
Document | build(InputSource in) This builds a document from the supplied input source. |
Document | build(InputStream in) This builds a document from the supplied input stream. |
Document | build(File file) This builds a document from the supplied filename. |
Document | build(URL url) This builds a document from the supplied URL. |
Document | build(InputStream in, String systemId) This builds a document from the supplied input stream. |
Document | build(Reader characterStream) This builds a document from the supplied Reader. |
Document | build(Reader characterStream, String SystemId) This builds a document from the supplied Reader. |
Document | build(String systemId) This builds a document from the supplied URI. |
protected void | configureContentHandler(SAXHandler contentHandler) This configures the SAXHandler that will be used to build the Document. |
protected void | configureParser(XMLReader parser, SAXHandler contentHandler) This configures the XMLReader to be used for reading the XML document. |
protected SAXHandler | createContentHandler() This creates the SAXHandler that will be used to build the Document. |
protected XMLReader | createParser() This creates the XMLReader to be used for reading the XML document. |
protected URL | fileToURL(File f)
Imitation of File.toURL(), a JDK 1.2 method, reimplemented
here to work with JDK 1.1.
|
void | setDTDHandler(DTDHandler dtdHandler)
This sets custom DTDHandler for the |
void | setEntityResolver(EntityResolver entityResolver)
This sets custom EntityResolver for the |
void | setErrorHandler(ErrorHandler errorHandler)
This sets custom ErrorHandler for the |
void | setExpandEntities(boolean expand) This sets whether or not to expand entities for the builder. |
void | setFactory(JDOMFactory factory) |
void | setFeature(String name, boolean value) This sets a feature on the SAX parser. |
void | setIgnoringElementContentWhitespace(boolean ignoringWhite) Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. |
void | setProperty(String name, Object value) This sets a property on the SAX parser. |
void | setValidation(boolean validate) This sets validation for the builder. |
void | setXMLFilter(XMLFilter xmlFilter)
This sets custom XMLFilter for the |
Creates a new SAXBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default SAX Drivers. The underlying parser will not validate.
Creates a new SAXBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default SAX Drivers. The underlying parser will validate or not according to the given parameter.
Parameters: validate boolean
indicating if
validation should occur.
Creates a new SAXBuilder using the specified SAX parser. The underlying parser will not validate.
Parameters: saxDriverClass String
name of SAX Driver
to use for parsing.
Creates a new SAXBuilder using the specified SAX parser. The underlying parser will validate or not according to the given parameter.
Parameters: saxDriverClass String
name of SAX Driver
to use for parsing. validate boolean
indicating if
validation should occur.
This builds a document from the supplied input source.
Parameters: in InputSource
to read from.
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied input stream.
Parameters: in InputStream
to read from.
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied filename.
Parameters: file File
to read from.
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied URL.
Parameters: url URL
to read from.
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied input stream.
Parameters: in InputStream
to read from. systemId base for resolving relative URIs
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied Reader.
Parameters: in Reader
to read from.
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied Reader.
Parameters: in Reader
to read from. systemId base for resolving relative URIs
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This builds a document from the supplied URI.
Parameters: systemId URI for the input
Returns: Document
- resultant Document object.
Throws: JDOMException when errors occur in parsing.
This configures the SAXHandler that will be used to build the Document.
The default implementation simply passes through some configuration settings that were set on the SAXBuilder: setExpandEntities() and setIgnoringElementContentWhitespace().
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.
This creates the SAXHandler that will be used to build the Document.
This creates the XMLReader to be used for reading the XML document.
The default behavior is to (1) use the saxDriverClass, if it has been set, (2) try to obtain a parser from JAXP, if it is available, and (3) if all else fails, use a hard-coded default parser (currently the Xerces parser). Subclasses may override this method to determine the parser to use in a different way.
Parameters: f the file to convert
Returns: the file path converted to a file: URL
See Also: java.io.File
This sets custom DTDHandler for the Builder
.
Parameters: dtdHandler DTDHandler
This sets custom EntityResolver for the Builder
.
Parameters: entityResolver EntityResolver
This sets custom ErrorHandler for the Builder
.
Parameters: errorHandler ErrorHandler
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 misreported if this flag is turned off, resulting in entities to appear 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.
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.
Parameters: name The feature name, which is a fully-qualified URI. value The requested state of the feature (true or false).
Specifies whether or not the parser should elminate 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
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.
Parameters: name The property name, which is a fully-qualified URI. value The requested value for the property.
This sets validation for the builder.
Parameters: validate boolean
indicating whether validation
should occur.
This sets custom XMLFilter for the Builder
.
Parameters: xmlFilter XMLFilter