org.jdom2.output

类 SAXOutputter

java.lang.Object

org.jdom2.output.SAXOutputter

public class SAXOutputter
extends java.lang.Object

Outputs a JDOM document as a stream of SAX2 events.

Most ContentHandler callbacks are supported. BOTH ignorableWhitespace() and skippedEntity() have not been implemented. The JDOMLocator class returned by getLocator() exposes the current node being operated upon.

At this time, it is not possible to access notations and unparsed entity references in a DTD from JDOM. 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 and at this point the document exists in memory and is known to have no errors.

作者:

Brett McLaughlin, Jason Hunter, Fred Trimble, Bradley S. Huffman

构造器概要

构造器

构造器和说明
SAXOutputter() This will create a SAXOutputter without any registered handler.
SAXOutputter(org.xml.sax.ContentHandler contentHandler) This will create a SAXOutputter with the specified ContentHandler.
SAXOutputter(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler, org.xml.sax.DTDHandler dtdHandler, org.xml.sax.EntityResolver entityResolver) This will create a SAXOutputter with the specified SAX2 handlers.
SAXOutputter(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler, org.xml.sax.DTDHandler dtdHandler, org.xml.sax.EntityResolver entityResolver, org.xml.sax.ext.LexicalHandler lexicalHandler) This will create a SAXOutputter with the specified SAX2 handlers.
SAXOutputter(SAXOutputProcessor processor, Format format, org.xml.sax.ContentHandler contentHandler, org.xml.sax.ErrorHandler errorHandler, org.xml.sax.DTDHandler dtdHandler, org.xml.sax.EntityResolver entityResolver, org.xml.sax.ext.LexicalHandler lexicalHandler) This will create a SAXOutputter with the specified SAX2 handlers.

方法概要

限定符和类型	方法和说明
org.xml.sax.ContentHandler	getContentHandler() Returns the registered ContentHandler.
org.xml.sax.ext.DeclHandler	getDeclHandler() Return the registered DeclHandler.
org.xml.sax.DTDHandler	getDTDHandler() Return the registered DTDHandler.
org.xml.sax.EntityResolver	getEntityResolver() Return the registered EntityResolver.
org.xml.sax.ErrorHandler	getErrorHandler() Return the registered ErrorHandler.
boolean	getFeature(java.lang.String name) This will look up the value of a SAX feature.
Format	getFormat() Get the current Format being used for output
org.xml.sax.ext.LexicalHandler	getLexicalHandler() Return the registered LexicalHandler.
JDOMLocator	getLocator() 已过时。 there is no way to get a meaningful document Locator outside of an active output process, and the contents of the locator are meaningless outside of an active output process anyway.
java.lang.Object	getProperty(java.lang.String name) This will look up the value of a SAX property.
boolean	getReportDTDEvents() Returns whether DTD events will be reported.
boolean	getReportNamespaceDeclarations() Returns whether attribute namespace declarations shall be reported as "xmlns" attributes.
SAXOutputProcessor	getSAXOutputProcessor() Get the current SAXOutputProcessor being used for output.
void	output(Document document) This will output the JDOM Document, firing off the SAX events that have been registered.
void	output(Element node) This will output a single JDOM element as a document, firing off the SAX events that have been registered.
void	output(java.util.List<? extends Content> nodes) This will output a list of JDOM nodes as a document, firing off the SAX events that have been registered.
void	outputFragment(Content node) This will output a single JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.
void	outputFragment(java.util.List<? extends Content> nodes) This will output a list of JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.
void	setContentHandler(org.xml.sax.ContentHandler contentHandler) This will set the ContentHandler.
void	setDeclHandler(org.xml.sax.ext.DeclHandler declHandler) This will set the DeclHandler.
void	setDTDHandler(org.xml.sax.DTDHandler dtdHandler) This will set the DTDHandler.
void	setEntityResolver(org.xml.sax.EntityResolver entityResolver) This will set the EntityResolver.
void	setErrorHandler(org.xml.sax.ErrorHandler errorHandler) This will set the ErrorHandler.
void	setFeature(java.lang.String name, boolean value)
void	setFormat(Format format) Set the current Format to be used for output.
void	setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler) This will set the LexicalHandler.
void	setProperty(java.lang.String name, java.lang.Object value)
void	setReportDTDEvents(boolean reportDtdEvents) This will define whether to report DTD events to SAX DeclHandlers and LexicalHandlers if these handlers are registered and the document to output includes a DocType declaration.
void	setReportNamespaceDeclarations(boolean declareNamespaces) This will define whether attribute namespace declarations shall be reported as "xmlns" attributes.
void	setSAXOutputProcessor(SAXOutputProcessor processor) Set the current SAXOutputProcessor to be used for output.

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SAXOutputter

public SAXOutputter()

This will create a SAXOutputter without any registered handler. The application is then responsible for registering them using the setXxxHandler() methods.

SAXOutputter

public SAXOutputter(org.xml.sax.ContentHandler contentHandler)

This will create a SAXOutputter with the specified ContentHandler.

参数:

contentHandler - contains ContentHandler callback methods

SAXOutputter

public SAXOutputter(org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ErrorHandler errorHandler,
                    org.xml.sax.DTDHandler dtdHandler,
                    org.xml.sax.EntityResolver entityResolver)

This will create a SAXOutputter with the specified SAX2 handlers. At this time, only ContentHandler and EntityResolver are supported.

参数:

contentHandler - contains ContentHandler callback methods

errorHandler - contains ErrorHandler callback methods

dtdHandler - contains DTDHandler callback methods

entityResolver - contains EntityResolver callback methods

SAXOutputter

public SAXOutputter(org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ErrorHandler errorHandler,
                    org.xml.sax.DTDHandler dtdHandler,
                    org.xml.sax.EntityResolver entityResolver,
                    org.xml.sax.ext.LexicalHandler lexicalHandler)

This will create a SAXOutputter with the specified SAX2 handlers. At this time, only ContentHandler and EntityResolver are supported.

参数:

contentHandler - contains ContentHandler callback methods

errorHandler - contains ErrorHandler callback methods

dtdHandler - contains DTDHandler callback methods

entityResolver - contains EntityResolver callback methods

lexicalHandler - contains LexicalHandler callbacks.

SAXOutputter

public SAXOutputter(SAXOutputProcessor processor,
                    Format format,
                    org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ErrorHandler errorHandler,
                    org.xml.sax.DTDHandler dtdHandler,
                    org.xml.sax.EntityResolver entityResolver,
                    org.xml.sax.ext.LexicalHandler lexicalHandler)

This will create a SAXOutputter with the specified SAX2 handlers. At this time, only ContentHandler and EntityResolver are supported.

参数:

processor - the SAXOutputProcessor to use for output.

format - the Format to use for output.

contentHandler - contains ContentHandler callback methods

errorHandler - contains ErrorHandler callback methods

dtdHandler - contains DTDHandler callback methods

entityResolver - contains EntityResolver callback methods

lexicalHandler - contains LexicalHandler callbacks.

方法详细资料

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)

This will set the ContentHandler.

参数:

contentHandler - contains ContentHandler callback methods.

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()

Returns the registered ContentHandler.

返回:

the current ContentHandler or null if none was registered.

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)

This will set the ErrorHandler.

参数:

errorHandler - contains ErrorHandler callback methods.

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()

Return the registered ErrorHandler.

返回:

the current ErrorHandler or null if none was registered.

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler dtdHandler)

This will set the DTDHandler.

参数:

dtdHandler - contains DTDHandler callback methods.

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()

Return the registered DTDHandler.

返回:

the current DTDHandler or null if none was registered.

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)

This will set the EntityResolver.

参数:

entityResolver - contains EntityResolver callback methods.

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()

Return the registered EntityResolver.

返回:

the current EntityResolver or null if none was registered.

setLexicalHandler

public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)

This will set the LexicalHandler.

参数:

lexicalHandler - contains lexical callback methods.

getLexicalHandler

public org.xml.sax.ext.LexicalHandler getLexicalHandler()

Return the registered LexicalHandler.

返回:

the current LexicalHandler or null if none was registered.

setDeclHandler

public void setDeclHandler(org.xml.sax.ext.DeclHandler declHandler)

This will set the DeclHandler.

参数:

declHandler - contains declaration callback methods.

getDeclHandler

public org.xml.sax.ext.DeclHandler getDeclHandler()

Return the registered DeclHandler.

返回:

the current DeclHandler or null if none was registered.

getReportNamespaceDeclarations

public boolean getReportNamespaceDeclarations()

Returns whether attribute namespace declarations shall be reported as "xmlns" attributes.

返回:

whether attribute namespace declarations shall be reported as "xmlns" attributes.

setReportNamespaceDeclarations

public void setReportNamespaceDeclarations(boolean declareNamespaces)

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.

参数:

declareNamespaces - whether attribute namespace declarations shall be reported as "xmlns" attributes.

getReportDTDEvents

public boolean getReportDTDEvents()

Returns whether DTD events will be reported.

返回:

whether DTD events will be reported

setReportDTDEvents

public void setReportDTDEvents(boolean reportDtdEvents)

This will define whether to report DTD events to SAX DeclHandlers and LexicalHandlers if these handlers are registered and the document to output includes a DocType declaration.

参数:

reportDtdEvents - whether to notify DTD events.

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException

抛出:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

getFeature

public boolean getFeature(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException

This will look up the value of a SAX feature.

参数:

name - String the feature name, which is a fully-qualified URI.

返回:

boolean the current state of the feature (true or false).

抛出:

org.xml.sax.SAXNotRecognizedException - when SAXOutputter does not recognize the feature name.

org.xml.sax.SAXNotSupportedException - when SAXOutputter recognizes the feature name but determine its value at this time.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException

抛出:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException

This will look up the value of a SAX property.

参数:

name - String the property name, which is a fully-qualified URI.

返回:

Object the current value of the property.

抛出:

org.xml.sax.SAXNotRecognizedException - when SAXOutputter does not recognize the property name.

org.xml.sax.SAXNotSupportedException - when SAXOutputter recognizes the property name but cannot determine its value at this time.

getSAXOutputProcessor

public SAXOutputProcessor getSAXOutputProcessor()

Get the current SAXOutputProcessor being used for output.

返回:

The current SAXOutputProcessor

setSAXOutputProcessor

public void setSAXOutputProcessor(SAXOutputProcessor processor)

Set the current SAXOutputProcessor to be used for output.

参数:

processor - the new SAXOutputProcessor

getFormat

public Format getFormat()

Get the current Format being used for output

返回:

the current Format

setFormat

public void setFormat(Format format)

Set the current Format to be used for output.

参数:

format - the new Format

output

public void output(Document document)
            throws JDOMException

This will output the JDOM Document, firing off the SAX events that have been registered.

参数:

document - JDOM Document to output.

抛出:

JDOMException - if any error occurred.

output

public void output(java.util.List<? extends Content> nodes)
            throws JDOMException

This will output a list of JDOM nodes as a document, firing off the SAX events that have been registered.

Warning: This method may output ill-formed XML documents if the list contains top-level objects that are not legal at the document level (e.g. Text or CDATA nodes, multiple Element nodes, etc.). Thus, it should only be used to output document portions towards ContentHandlers capable of accepting such ill-formed documents (such as XSLT processors).

参数:

nodes - List of JDOM nodes to output.

抛出:

JDOMException - if any error occurred.

另请参阅:

output(org.jdom2.Document)

output

public void output(Element node)
            throws JDOMException

This will output a single JDOM element as a document, firing off the SAX events that have been registered.

参数:

node - the Element node to output.

抛出:

JDOMException - if any error occurred.

outputFragment

public void outputFragment(java.util.List<? extends Content> nodes)
                    throws JDOMException

This will output a list of JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.

Warning: This method does not call the ContentHandler.setDocumentLocator(org.xml.sax.Locator), ContentHandler.startDocument() and ContentHandler.endDocument() callbacks on the ContentHandler. The user shall invoke these methods directly prior/after outputting the document fragments.

参数:

nodes - List of JDOM nodes to output.

抛出:

JDOMException - if any error occurred.

另请参阅:

outputFragment(org.jdom2.Content)

outputFragment

public void outputFragment(Content node)
                    throws JDOMException

This will output a single JDOM nodes as a fragment of an XML document, firing off the SAX events that have been registered.

Warning: This method does not call the ContentHandler.setDocumentLocator(org.xml.sax.Locator), ContentHandler.startDocument() and ContentHandler.endDocument() callbacks on the ContentHandler. The user shall invoke these methods directly prior/after outputting the document fragments.

参数:

node - the Content node to output.

抛出:

JDOMException - if any error occurred.

另请参阅:

outputFragment(java.util.List)

getLocator

@Deprecated
public JDOMLocator getLocator()

已过时。 there is no way to get a meaningful document Locator outside of an active output process, and the contents of the locator are meaningless outside of an active output process anyway.

Returns null.

返回:

null