|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xml.serialize.BaseMarkupSerializer | +--org.apache.xml.serialize.XMLSerializer
Implements an XML serializer supporting both DOM and SAX pretty
serializing. For usage instructions see Serializer
.
If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.
The serializer supports both DOM and SAX. SAX serializing is done by firing
SAX events and using the serializer as a document handler. DOM serializing is done
by calling BaseMarkupSerializer.serialize(Document)
or by using DOM Level 3
DOMWriter
and
serializing with DOMWriter.writeNode(java.io.OutputStream, org.w3c.dom.Node)
,
DOMWriter.writeToString(org.w3c.dom.Node)
.
If an I/O exception occurs while serializing, the serializer
will not throw an exception directly, but only throw it
at the end of serializing (either DOM or SAX's DocumentHandler.endDocument()
.
For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.
Serializer
Field Summary | |
protected static boolean |
DEBUG
|
protected boolean |
fDOML1
|
protected java.lang.String |
fEmptySymbol
|
protected org.apache.xerces.util.NamespaceSupport |
fLocalNSBinder
stores all namespace bindings on the current element |
protected int |
fNamespaceCounter
|
protected boolean |
fNamespaces
|
protected org.apache.xerces.util.NamespaceSupport |
fNSBinder
stores namespaces in scope |
protected org.apache.xerces.util.SymbolTable |
fSymbolTable
symbol table for serialization |
protected java.lang.String |
fXmlnsSymbol
|
protected java.lang.String |
fXmlSymbol
|
Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer |
_docTypePublicId, _docTypeSystemId, _format, _indenting, _prefixes, _printer, _started, fDOMError, fDOMErrorHandler, fFeatures, fStrBuffer |
Constructor Summary | |
XMLSerializer()
Constructs a new serializer. |
|
XMLSerializer(OutputFormat format)
Constructs a new serializer. |
|
XMLSerializer(java.io.OutputStream output,
OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
XMLSerializer(java.io.Writer writer,
OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
boolean |
canSetFeature(java.lang.String name,
boolean state)
Query whether setting a feature to a specific value is supported. |
void |
endElement(java.lang.String tagName)
Receive notification of the end of an element. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
Receive notification of the end of an element. |
void |
endElementIO(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
|
java.lang.String |
getEncoding()
The character encoding in which the output will be written. |
protected java.lang.String |
getEntityRef(int ch)
Returns the suitable entity reference for this character value, or null if no such entity exists. |
org.apache.xerces.dom3.DOMErrorHandler |
getErrorHandler()
The error handler that will receive error notifications during serialization. |
boolean |
getFeature(java.lang.String name)
Look up the value of a feature. |
java.lang.String |
getLastEncoding()
The actual character encoding that was last used by this formatter. |
java.lang.String |
getNewLine()
The end-of-line sequence of characters to be used in the XML being written out. |
void |
initDOMFeatures()
Initialize DOM Level 3 features |
boolean |
reset()
|
protected void |
serializeElement(org.w3c.dom.Element elem)
Called to serialize a DOM element. |
void |
setEncoding(java.lang.String encoding)
The character encoding in which the output will be written. |
void |
setErrorHandler(org.apache.xerces.dom3.DOMErrorHandler errorHandler)
The error handler that will receive error notifications during serialization. |
void |
setFeature(java.lang.String name,
boolean state)
Set the state of a feature. |
void |
setNamespaces(boolean namespaces)
If true, activate namespace support by performing DOM L3 namespace fixup algorithm |
void |
setNewLine(java.lang.String newLine)
The end-of-line sequence of characters to be used in the XML being written out. |
void |
setOutputFormat(OutputFormat format)
Specifies an output format for this serializer. |
protected void |
startDocument(java.lang.String rootTagName)
Called to serialize the document's DOCTYPE by the root element. |
void |
startElement(java.lang.String tagName,
org.xml.sax.AttributeList attrs)
Receive notification of the beginning of an element. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
org.xml.sax.Attributes attrs)
Receive notification of the beginning of an element. |
boolean |
writeNode(java.io.OutputStream destination,
org.w3c.dom.Node wnode)
Write out the specified node as described above in the description of DOMWriter . |
java.lang.String |
writeToString(org.w3c.dom.Node wnode)
Serialize the specified node as described above in the description of DOMWriter . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final boolean DEBUG
protected org.apache.xerces.util.NamespaceSupport fNSBinder
protected org.apache.xerces.util.NamespaceSupport fLocalNSBinder
protected final org.apache.xerces.util.SymbolTable fSymbolTable
protected java.lang.String fEmptySymbol
protected java.lang.String fXmlSymbol
protected java.lang.String fXmlnsSymbol
protected boolean fDOML1
protected int fNamespaceCounter
protected boolean fNamespaces
Constructor Detail |
public XMLSerializer()
#setOutFputCharStream
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public XMLSerializer(OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public XMLSerializer(java.io.Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic XMLSerializer(java.io.OutputStream output, OutputFormat format)
output
- The output stream to useformat
- The output format to use, null for the defaultMethod Detail |
public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in class BaseMarkupSerializer
org.apache.xml.serialize.Serializer
format
- The output format to usepublic void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
org.xml.sax.ContentHandler
The Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
endElement
event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixes
property is true (it is false by default, and support for a
true value is optional).
org.xml.sax.ContentHandler
uri
- The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName
- The qualified name (with prefix), or the
empty string if qualified names are not available.atts
- The attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object.org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws org.xml.sax.SAXException
org.xml.sax.ContentHandler
The SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
startElement
event for every endElement
event (even when the element is empty).
For information on the names, see startElement.
org.xml.sax.ContentHandler
uri
- The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName
- The qualified XML 1.0 name (with prefix), or the
empty string if qualified names are not available.org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.public void endElementIO(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws java.io.IOException
public void startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs) throws org.xml.sax.SAXException
org.xml.sax.DocumentHandler
The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.
If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.
org.xml.sax.DocumentHandler
name
- The element type name.atts
- The attributes attached to the element, if any.org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.DocumentHandler.endElement(java.lang.String)
,
AttributeList
public void endElement(java.lang.String tagName) throws org.xml.sax.SAXException
org.xml.sax.DocumentHandler
The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).
If the element name has a namespace prefix, the prefix will still be attached to the name.
org.xml.sax.DocumentHandler
name
- The element type nameorg.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.protected void startDocument(java.lang.String rootTagName) throws java.io.IOException
This method will check if it has not been called before (BaseMarkupSerializer._started
),
will serialize the document type declaration, and will serialize all
pre-root comments and PIs that were accumulated in the document
(see BaseMarkupSerializer.serializePreRoot()
). Pre-root will be serialized even if
this is not the first root element of the document.
protected void serializeElement(org.w3c.dom.Element elem) throws java.io.IOException
startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
, endElement(java.lang.String, java.lang.String, java.lang.String)
and serializing everything
inbetween, but better optimized.serializeElement
in class BaseMarkupSerializer
org.apache.xml.serialize.BaseMarkupSerializer
elem
- The element to serializejava.io.IOException
- An I/O exception occured while
serializingprotected java.lang.String getEntityRef(int ch)
BaseMarkupSerializer
getEntityRef
in class BaseMarkupSerializer
org.apache.xml.serialize.BaseMarkupSerializer
ch
- Character valuepublic void setNamespaces(boolean namespaces)
namespaces
- public void initDOMFeatures()
public void setFeature(java.lang.String name, boolean state) throws org.w3c.dom.DOMException
DOMWriter
to recognize a feature
name but to be unable to set its value.setFeature
in interface org.apache.xerces.dom3.ls.DOMWriter
name
- The feature name.state
- The requested state of the feature (true
or
false
).org.w3c.dom.DOMException
- Raise a NOT_SUPPORTED_ERR exception when the DOMWriter
recognizes the feature name but cannot set the requested value.
DOMWriter
does not
recognize the feature name.public boolean canSetFeature(java.lang.String name, boolean state)
canSetFeature
in interface org.apache.xerces.dom3.ls.DOMWriter
name
- The feature name, which is a DOM has-feature style string.state
- The requested state of the feature (true
or
false
).true
if the feature could be successfully set to
the specified value, or false
if the feature is not
recognized or the requested value is not supported. The value of
the feature itself is not changed.public boolean getFeature(java.lang.String name) throws org.w3c.dom.DOMException
getFeature
in interface org.apache.xerces.dom3.ls.DOMWriter
name
- The feature name, which is a string with DOM has-feature
syntax.true
or
false
).org.w3c.dom.DOMException
- Raise a NOT_FOUND_ERR When the DOMWriter
does not
recognize the feature name.public java.lang.String getEncoding()
null
or empty, but the item to be
written includes an encoding declaration, that value will be used.If
neither of the above provides an encoding name, a default encoding of
"UTF-8" will be used.
null
.getEncoding
in interface org.apache.xerces.dom3.ls.DOMWriter
public void setEncoding(java.lang.String encoding)
null
or empty, but the item to be
written includes an encoding declaration, that value will be used.If
neither of the above provides an encoding name, a default encoding of
"UTF-8" will be used.
null
.setEncoding
in interface org.apache.xerces.dom3.ls.DOMWriter
public java.lang.String getLastEncoding()
getLastEncoding
in interface org.apache.xerces.dom3.ls.DOMWriter
public java.lang.String getNewLine()
null
null
.getNewLine
in interface org.apache.xerces.dom3.ls.DOMWriter
public void setNewLine(java.lang.String newLine)
null
null
.setNewLine
in interface org.apache.xerces.dom3.ls.DOMWriter
public org.apache.xerces.dom3.DOMErrorHandler getErrorHandler()
getErrorHandler
in interface org.apache.xerces.dom3.ls.DOMWriter
public void setErrorHandler(org.apache.xerces.dom3.DOMErrorHandler errorHandler)
setErrorHandler
in interface org.apache.xerces.dom3.ls.DOMWriter
public boolean writeNode(java.io.OutputStream destination, org.w3c.dom.Node wnode) throws java.lang.Exception
DOMWriter
. Writing a Document or Entity node produces a
serialized form that is well formed XML. Writing other node types
produces a fragment of text in a form that is not fully defined by
this document, but that should be useful to a human for debugging or
diagnostic purposes.writeNode
in interface org.apache.xerces.dom3.ls.DOMWriter
destination
- The destination for the data to be written.wnode
- The Document
or Entity
node to
be written. For other node types, something sensible should be
written, but the exact serialized form is not specified.true
if node
was
successfully serialized and false
in case a failure
occured and the failure wasn't canceled by the error handler.DOMSystemException
- This exception will be raised in response to any sort of IO or system
error that occurs while writing to the destination. It may wrap an
underlying system exception.public java.lang.String writeToString(org.w3c.dom.Node wnode) throws org.w3c.dom.DOMException
DOMWriter
. The result of serializing the node is
returned as a string. Writing a Document or Entity node produces a
serialized form that is well formed XML. Writing other node types
produces a fragment of text in a form that is not fully defined by
this document, but that should be useful to a human for debugging or
diagnostic purposes.writeToString
in interface org.apache.xerces.dom3.ls.DOMWriter
wnode
- The node to be written.null
in case a
failure occured and the failure wasn't canceled by the error
handler.org.w3c.dom.DOMException
- DOMSTRING_SIZE_ERR: The resulting string is too long to fit in a
DOMString
.public boolean reset()
reset
in class BaseMarkupSerializer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |