Class XMLSerializer
- All Implemented Interfaces:
DOMSerializer
,Serializer
,ContentHandler
,DocumentHandler
,DTDHandler
,DeclHandler
,LexicalHandler
- Direct Known Subclasses:
XML11Serializer
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
LSSerializer
and
serializing with LSSerializer.write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)
,
LSSerializer.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.
- Version:
- $Revision: 704573 $ $Date: 2008-10-14 21:41:22 +0530 (Tue, 14 Oct 2008) $
- Author:
- Assaf Arkin, Rahul Srivastava, Elena Litani IBM
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final boolean
Deprecated.protected org.apache.xerces.util.NamespaceSupport
Deprecated.stores all namespace bindings on the current elementprotected boolean
Deprecated.Controls whether namespace prefixes will be printed out during serializationprotected boolean
Deprecated.Controls whether namespace fixup should be performed during the serialization.protected org.apache.xerces.util.NamespaceSupport
Deprecated.stores namespaces in scopeprotected org.apache.xerces.util.SymbolTable
Deprecated.symbol table for serializationprotected static final String
Deprecated.Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer
_docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fCurrentNode, fDOMError, fDOMErrorHandler, fDOMFilter, features, fStrBuffer
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Constructs a new serializer.XMLSerializer
(OutputStream output, OutputFormat format) Deprecated.Constructs a new serializer that writes to the specified output stream using the specified output format.XMLSerializer
(Writer writer, OutputFormat format) Deprecated.Constructs a new serializer that writes to the specified writer using the specified output format.XMLSerializer
(OutputFormat format) Deprecated.Constructs a new serializer. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Deprecated.DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.void
endElement
(String tagName) Deprecated.void
endElement
(String namespaceURI, String localName, String rawName) Deprecated.void
endElementIO
(String namespaceURI, String localName, String rawName) Deprecated.protected String
getEntityRef
(int ch) Deprecated.Returns the suitable entity reference for this character value, or null if no such entity exists.protected void
printEscaped
(String source) Deprecated.Escapes a string so it may be printed as text content or attribute value.protected void
printText
(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) Deprecated.Called to print additional text with whitespace handling.protected void
Deprecated.protected void
printXMLChar
(int ch) Deprecated.print text databoolean
reset()
Deprecated.protected void
serializeElement
(Element elem) Deprecated.Called to serialize a DOM element.void
setNamespaces
(boolean namespaces) Deprecated.This methods turns on namespace fixup algorithm during DOM serialization.void
setOutputFormat
(OutputFormat format) Deprecated.Specifies an output format for this serializer.protected void
startDocument
(String rootTagName) Deprecated.Called to serialize the document's DOCTYPE by the root element.void
startElement
(String namespaceURI, String localName, String rawName, Attributes attrs) Deprecated.void
startElement
(String tagName, AttributeList attrs) Deprecated.Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, characters, characters, cleanup, comment, comment, content, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, processingInstruction, processingInstructionIO, serialize, serialize, serialize, serializeNode, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, surrogates, unparsedEntityDecl
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
declaration
-
Field Details
-
DEBUG
protected static final boolean DEBUGDeprecated.- See Also:
-
fNSBinder
protected org.apache.xerces.util.NamespaceSupport fNSBinderDeprecated.stores namespaces in scope -
fLocalNSBinder
protected org.apache.xerces.util.NamespaceSupport fLocalNSBinderDeprecated.stores all namespace bindings on the current element -
fSymbolTable
protected org.apache.xerces.util.SymbolTable fSymbolTableDeprecated.symbol table for serialization -
PREFIX
Deprecated.- See Also:
-
fNamespaces
protected boolean fNamespacesDeprecated.Controls whether namespace fixup should be performed during the serialization. NOTE: if this field is set to true the following fields need to be initialized: fNSBinder, fLocalNSBinder, fSymbolTable, XMLSymbols.EMPTY_STRING, fXmlSymbol, fXmlnsSymbol -
fNamespacePrefixes
protected boolean fNamespacePrefixesDeprecated.Controls whether namespace prefixes will be printed out during serialization
-
-
Constructor Details
-
XMLSerializer
public XMLSerializer()Deprecated.Constructs a new serializer. The serializer cannot be used without callingBaseMarkupSerializer.setOutputCharStream(java.io.Writer)
orBaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first. -
XMLSerializer
Deprecated.Constructs a new serializer. The serializer cannot be used without callingBaseMarkupSerializer.setOutputCharStream(java.io.Writer)
orBaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first. -
XMLSerializer
Deprecated.Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.- Parameters:
writer
- The writer to useformat
- The output format to use, null for the default
-
XMLSerializer
Deprecated.Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.- Parameters:
output
- The output stream to useformat
- The output format to use, null for the default
-
-
Method Details
-
setOutputFormat
Deprecated.Description copied from interface:Serializer
Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.- Specified by:
setOutputFormat
in interfaceSerializer
- Overrides:
setOutputFormat
in classBaseMarkupSerializer
- Parameters:
format
- The output format to use
-
setNamespaces
public void setNamespaces(boolean namespaces) Deprecated.This methods turns on namespace fixup algorithm during DOM serialization.- Parameters:
namespaces
-- See Also:
-
startElement
public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException Deprecated.- Throws:
SAXException
-
endElement
Deprecated.- Throws:
SAXException
-
endElementIO
Deprecated.- Throws:
IOException
-
startElement
Deprecated.- Throws:
SAXException
-
endElement
Deprecated.- Throws:
SAXException
-
startDocument
Deprecated.Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.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 (seeBaseMarkupSerializer.serializePreRoot()
). Pre-root will be serialized even if this is not the first root element of the document.- Throws:
IOException
-
serializeElement
Deprecated.Called to serialize a DOM element. Equivalent to callingstartElement(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.- Specified by:
serializeElement
in classBaseMarkupSerializer
- Parameters:
elem
- The element to serialize- Throws:
IOException
- An I/O exception occured while serializing
-
getEntityRef
Deprecated.Description copied from class:BaseMarkupSerializer
Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".- Specified by:
getEntityRef
in classBaseMarkupSerializer
- Parameters:
ch
- Character value- Returns:
- Character entity name, or null
-
printEscaped
Deprecated.Description copied from class:BaseMarkupSerializer
Escapes a string so it may be printed as text content or attribute value. Non printable characters are escaped using character references. Where the format specifies a deault entity reference, that reference is used (e.g. <).- Overrides:
printEscaped
in classBaseMarkupSerializer
- Parameters:
source
- The string to escape- Throws:
IOException
-
printXMLChar
Deprecated.print text data- Throws:
IOException
-
printText
Deprecated.- Overrides:
printText
in classBaseMarkupSerializer
- Throws:
IOException
-
printText
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException Deprecated.Description copied from class:BaseMarkupSerializer
Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by callingBaseMarkupSerializer.printText(String,boolean,boolean)
with a call toPrinter.breakLine()
for each new line. If spaces are not preserved, the text is broken at space boundaries if longer than the line width; Multiple spaces are printed as such, but spaces at beginning of line are removed.- Overrides:
printText
in classBaseMarkupSerializer
- Parameters:
chars
- The text to printstart
- The start offsetlength
- The number of characterspreserveSpace
- Space preserving flagunescaped
- Print unescaped- Throws:
IOException
-
checkUnboundNamespacePrefixedNode
Deprecated.DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.- Overrides:
checkUnboundNamespacePrefixedNode
in classBaseMarkupSerializer
- Parameters:
node
- The node to check for unbound namespace prefices- Throws:
IOException
-
reset
public boolean reset()Deprecated.- Overrides:
reset
in classBaseMarkupSerializer
-