Interface SAXEngine
- All Known Implementing Classes:
SAXBuilder
,SAXBuilderEngine
- Author:
- Rolf Lear
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionThis builds a document from the supplied filename.build
(InputStream in) This builds a document from the supplied input stream.build
(InputStream in, String systemId) This builds a document from the supplied input stream.This builds a document from the supplied Reader.This builds a document from the supplied Reader.This builds a document from the supplied URI.This builds a document from the supplied URL.build
(InputSource in) This builds a document from the supplied input source.Returns theDTDHandler
assigned, or null if none.Returns theEntityResolver
assigned, or null if none.Returns theErrorHandler
assigned, or null if none.boolean
Returns whether or not entities are being expanded into normal text content.boolean
Returns whether or not the parser will eliminate element content containing only whitespace.boolean
Returns whether element content whitespace is to be ignored during the build.Returns the currentJDOMFactory
in use.boolean
Returns whether validation is to be performed during the build.
-
Method Details
-
getJDOMFactory
JDOMFactory getJDOMFactory()Returns the currentJDOMFactory
in use.- Returns:
- the factory in use
-
isValidating
boolean isValidating()Returns whether validation is to be performed during the build.- Returns:
- whether validation is to be performed during the build
-
getErrorHandler
ErrorHandler getErrorHandler()Returns theErrorHandler
assigned, or null if none.- Returns:
- the ErrorHandler assigned, or null if none
-
getEntityResolver
EntityResolver getEntityResolver()Returns theEntityResolver
assigned, or null if none.- Returns:
- the EntityResolver assigned
-
getDTDHandler
DTDHandler getDTDHandler()Returns theDTDHandler
assigned, or null if none.- Returns:
- the DTDHandler assigned
-
getIgnoringElementContentWhitespace
boolean getIgnoringElementContentWhitespace()Returns whether element content whitespace is to be ignored during the build.- Returns:
- whether element content whitespace is to be ignored during the build
-
getIgnoringBoundaryWhitespace
boolean getIgnoringBoundaryWhitespace()Returns whether or not the parser will eliminate element content containing only whitespace.- Returns:
boolean
- whether only whitespace content will be ignored during build.
-
getExpandEntities
boolean getExpandEntities()Returns whether or not entities are being expanded into normal text content.- Returns:
- whether entities are being expanded
-
build
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 parsingIOException
- when an I/O error prevents a document from being fully parsed
-
build
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 parsingIOException
- when an I/O error prevents a document from being fully parsed.
-
build
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 parsingIOException
- when an I/O error prevents a document from being fully parsed
-
build
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 parsingIOException
- when an I/O error prevents a document from being fully parsed.
-
build
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 parsingIOException
- when an I/O error prevents a document from being fully parsed
-
build
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.
- Parameters:
characterStream
-Reader
to read from- Returns:
Document
resultant Document object- Throws:
JDOMException
- when errors occur in parsingIOException
- when an I/O error prevents a document from being fully parsed
-
build
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.
- Parameters:
characterStream
-Reader
to read from.systemId
- base for resolving relative URIs- Returns:
Document
resultant Document object- Throws:
JDOMException
- when errors occur in parsingIOException
- when an I/O error prevents a document from being fully parsed
-
build
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 parsingIOException
- when an I/O error prevents a document from being fully parsed
-