org.jdom.output
public class SAXOutputter extends Object
SAXOutputter
takes a JDOM tree and fires SAX2 events.
ContentHandler
callbacks are supported. Both
ignorableWhitespace
and skippedEntity
have
not been implemented. The setDocumentLocator
callback has
been implemented, but the locator object always returns -1 for
getColumnNumber
and getLineNumber
.
The EntityResolver
callback resolveEntity
has
been implemented for DTDs.
At this time, it is not possible to access notations and unparsed entity
references in a DTD from a JDOM tree. Therefore, DTDHandler
callbacks have not been implemented yet.
The ErrorHandler
callbacks have not been implemented, since
these are supposed to be invoked when the document is parsed. However, the
document has already been parsed in order to create the JDOM tree.
Version: $Revision: 1.18 $, $Date: 2002/01/08 09:17:10 $
Constructor Summary | |
---|---|
SAXOutputter()
This will create a | |
SAXOutputter(ContentHandler contentHandler)
This will create a | |
SAXOutputter(ContentHandler contentHandler, ErrorHandler errorHandler, DTDHandler dtdHandler, EntityResolver entityResolver)
This will create a | |
SAXOutputter(ContentHandler contentHandler, ErrorHandler errorHandler, DTDHandler dtdHandler, EntityResolver entityResolver, LexicalHandler lexicalHandler)
This will create a |
Method Summary | |
---|---|
protected XMLReader | createParser() Creates a SAX XMLReader. |
ContentHandler | getContentHandler()
Returns the registered |
DeclHandler | getDeclHandler()
Return the registered |
DTDHandler | getDTDHandler()
Return the registered |
EntityResolver | getEntityResolver()
Return the registered |
ErrorHandler | getErrorHandler()
Return the registered |
boolean | getFeature(String name) This will look up the value of a SAX feature. |
LexicalHandler | getLexicalHandler()
Return the registered |
Object | getProperty(String name) This will look up the value of a SAX property. |
void | output(Document document)
This will output the |
void | setContentHandler(ContentHandler contentHandler)
This will set the |
void | setDeclHandler(DeclHandler declHandler)
This will set the |
void | setDTDHandler(DTDHandler dtdHandler)
This will set the |
void | setEntityResolver(EntityResolver entityResolver)
This will set the |
void | setErrorHandler(ErrorHandler errorHandler)
This will set the |
void | setFeature(String name, boolean value) This will set the state of a SAX feature. |
void | setLexicalHandler(LexicalHandler lexicalHandler)
This will set the |
void | setProperty(String name, Object value) This will set the value of a SAX property. |
void | setReportNamespaceDeclarations(boolean declareNamespaces) This will define whether attribute namespace declarations shall be reported as "xmlns" attributes. |
This will create a SAXOutputter
without any
registered handler. The application is then responsible for
registering them using the setXxxHandler()
methods.
This will create a SAXOutputter
with the
specified ContentHandler
.
Parameters: contentHandler contains ContentHandler
callback methods
This will create a SAXOutputter
with the
specified SAX2 handlers. At this time, only ContentHandler
and EntityResolver
are supported.
Parameters: contentHandler contains ContentHandler
callback methods errorHandler contains ErrorHandler
callback methods dtdHandler contains DTDHandler
callback methods entityResolver contains EntityResolver
callback methods
This will create a SAXOutputter
with the
specified SAX2 handlers. At this time, only ContentHandler
and EntityResolver
are supported.
Parameters: contentHandler contains ContentHandler
callback methods errorHandler contains ErrorHandler
callback methods dtdHandler contains DTDHandler
callback methods entityResolver contains EntityResolver
callback methods lexicalHandler contains LexicalHandler
callbacks.
Creates a SAX XMLReader.
Returns: XMLReader
a SAX2 parser.
Throws: Exception if no parser can be created.
Returns the registered ContentHandler
.
Returns: the current ContentHandler
or
null
if none was registered.
Return the registered DeclHandler
.
Returns: the current DeclHandler
or
null
if none was registered.
Return the registered DTDHandler
.
Returns: the current DTDHandler
or
null
if none was registered.
Return the registered EntityResolver
.
Returns: the current EntityResolver
or
null
if none was registered.
Return the registered ErrorHandler
.
Returns: the current ErrorHandler
or
null
if none was registered.
This will look up the value of a SAX feature.
Parameters: name String
the feature name, which is a
fully-qualified URI.
Returns: boolean
the current state of the feature
(true or false).
Throws: SAXNotRecognizedException When SAXOutputter does not recognize the feature name. SAXNotSupportedException When SAXOutputter recognizes the feature name but determine its value at this time.
Return the registered LexicalHandler
.
Returns: the current LexicalHandler
or
null
if none was registered.
This will look up the value of a SAX property.
Parameters: name String
the property name, which is a
fully-qualified URI.
Returns: Object
the current value of the property.
Throws: SAXNotRecognizedException When SAXOutputter does not recognize the property name. SAXNotSupportedException When SAXOutputter recognizes the property name but cannot determine its value at this time.
This will output the JDOM Document
, firing off the
SAX events that have been registered.
Parameters: document JDOM Document
to output.
This will set the ContentHandler
.
Parameters: contentHandler contains ContentHandler
callback methods.
This will set the DeclHandler
.
Parameters: declHandler contains declaration callback methods.
This will set the DTDHandler
.
Parameters: dtdHandler contains DTDHandler
callback methods.
This will set the EntityResolver
.
Parameters: entityResolver contains EntityResolver callback methods.
This will set the ErrorHandler
.
Parameters: errorHandler contains ErrorHandler
callback methods.
This will set the state of a SAX feature.
All XMLReaders are required to support setting to true and to false.
SAXOutputter currently supports the following SAX core features:
http://xml.org/sax/features/namespaces
true
!http://xml.org/sax/features/namespace-prefixes
Parameters: name String
the feature name, which is a
fully-qualified URI. value boolean
the requested state of the
feature (true or false).
Throws: SAXNotRecognizedException When SAXOutputter does not recognize the feature name. SAXNotSupportedException When SAXOutputter recognizes the feature name but cannot set the requested value.
This will set the LexicalHandler
.
Parameters: lexicalHandler contains lexical callback methods.
This will set the value of a SAX property. This method is also the standard mechanism for setting extended handlers.
SAXOutputter currently supports the following SAX properties:
http://xml.org/sax/properties/lexical-handler
org.xml.sax.ext.LexicalHandler
http://xml.org/sax/properties/declaration-handler
org.xml.sax.ext.DeclHandler
Parameters: name String
the property name, which is a
fully-qualified URI. value Object
the requested value for the property.
Throws: SAXNotRecognizedException When SAXOutputter does not recognize the property name. SAXNotSupportedException When SAXOutputter recognizes the property name but cannot set the requested value.
This will define whether attribute namespace declarations shall be
reported as "xmlns" attributes. This flag defaults to false
and behaves as the "namespace-prefixes" SAX core feature.
Parameters: reportDecl whether attribute namespace declarations shall be reported as "xmlns" attributes.