public class XMLSerializer extends BaseMarkupSerializer
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.
Serializer| Modifier and Type | Field and Description |
|---|---|
protected static boolean |
DEBUG
Deprecated.
|
protected org.apache.xerces.util.NamespaceSupport |
fLocalNSBinder
Deprecated.
stores all namespace bindings on the current element
|
protected boolean |
fNamespacePrefixes
Deprecated.
Controls whether namespace prefixes will be printed out during serialization
|
protected boolean |
fNamespaces
Deprecated.
Controls whether namespace fixup should be performed during
the serialization.
|
protected org.apache.xerces.util.NamespaceSupport |
fNSBinder
Deprecated.
stores namespaces in scope
|
protected org.apache.xerces.util.SymbolTable |
fSymbolTable
Deprecated.
symbol table for serialization
|
protected static java.lang.String |
PREFIX
Deprecated.
|
_docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fCurrentNode, fDOMError, fDOMErrorHandler, fDOMFilter, features, fStrBuffer| Constructor and Description |
|---|
XMLSerializer()
Deprecated.
Constructs a new serializer.
|
XMLSerializer(OutputFormat format)
Deprecated.
Constructs a new serializer.
|
XMLSerializer(java.io.OutputStream output,
OutputFormat format)
Deprecated.
Constructs a new serializer that writes to the specified output
stream using the specified output format.
|
XMLSerializer(java.io.Writer writer,
OutputFormat format)
Deprecated.
Constructs a new serializer that writes to the specified writer
using the specified output format.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkUnboundNamespacePrefixedNode(org.w3c.dom.Node node)
Deprecated.
DOM Level 3:
Check a node to determine if it contains unbound namespace prefixes.
|
void |
endElement(java.lang.String tagName)
Deprecated.
Receive notification of the end of an element.
|
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
Deprecated.
Receive notification of the end of an element.
|
void |
endElementIO(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
Deprecated.
|
protected java.lang.String |
getEntityRef(int ch)
Deprecated.
Returns the suitable entity reference for this character value,
or null if no such entity exists.
|
protected void |
printEscaped(java.lang.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 |
printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
Deprecated.
|
protected void |
printXMLChar(int ch)
Deprecated.
print text data
|
boolean |
reset()
Deprecated.
|
protected void |
serializeElement(org.w3c.dom.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(java.lang.String rootTagName)
Deprecated.
Called to serialize the document's DOCTYPE by the root element.
|
void |
startElement(java.lang.String tagName,
org.xml.sax.AttributeList attrs)
Deprecated.
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)
Deprecated.
Receive notification of the beginning of an element.
|
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, unparsedEntityDeclprotected static final boolean DEBUG
protected org.apache.xerces.util.NamespaceSupport fNSBinder
protected org.apache.xerces.util.NamespaceSupport fLocalNSBinder
protected org.apache.xerces.util.SymbolTable fSymbolTable
protected static final java.lang.String PREFIX
protected boolean fNamespaces
protected boolean fNamespacePrefixes
public XMLSerializer()
BaseMarkupSerializer.setOutputCharStream(java.io.Writer) 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 defaultpublic void setOutputFormat(OutputFormat format)
SerializersetOutputFormat in interface SerializersetOutputFormat in class BaseMarkupSerializerformat - The output format to usepublic void setNamespaces(boolean namespaces)
namespaces - LSSerializerpublic 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.ContentHandlerThe 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).
Like characters(), attribute values may have
characters that need more than one char value.
namespaceURI - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName - the local name (without prefix), or the
empty string if Namespace processing is not being
performedrawName - the qualified name (with prefix), or the
empty string if qualified names are not availableattrs - the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefinedorg.xml.sax.SAXException - any SAX exception, possibly
wrapping another exceptionContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String),
Attributes,
AttributesImplpublic void endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
throws org.xml.sax.SAXException
org.xml.sax.ContentHandlerThe 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.
namespaceURI - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName - the local name (without prefix), or the
empty string if Namespace processing is not being
performedrawName - the qualified XML name (with prefix), or the
empty string if qualified names are not availableorg.xml.sax.SAXException - any SAX exception, possibly
wrapping another exceptionpublic void endElementIO(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
throws java.io.IOException
java.io.IOExceptionpublic void startElement(java.lang.String tagName,
org.xml.sax.AttributeList attrs)
throws org.xml.sax.SAXException
org.xml.sax.DocumentHandlerThe 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.
tagName - The element type name.attrs - The attributes attached to the element, if any.org.xml.sax.SAXException - Any SAX exception, possibly
wrapping another exception.DocumentHandler.endElement(java.lang.String),
AttributeListpublic void endElement(java.lang.String tagName)
throws org.xml.sax.SAXException
org.xml.sax.DocumentHandlerThe 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.
tagName - 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.
java.io.IOExceptionprotected 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 BaseMarkupSerializerelem - The element to serializejava.io.IOException - An I/O exception occured while
serializingprotected java.lang.String getEntityRef(int ch)
BaseMarkupSerializergetEntityRef in class BaseMarkupSerializerch - Character valueprotected void printEscaped(java.lang.String source)
throws java.io.IOException
BaseMarkupSerializerprintEscaped in class BaseMarkupSerializersource - The string to escapejava.io.IOExceptionprotected void printXMLChar(int ch)
throws java.io.IOException
java.io.IOExceptionprotected void printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
throws java.io.IOException
printText in class BaseMarkupSerializerjava.io.IOExceptionprotected void printText(char[] chars,
int start,
int length,
boolean preserveSpace,
boolean unescaped)
throws java.io.IOException
BaseMarkupSerializerBaseMarkupSerializer.printText(String,boolean,boolean) with a call to Printer.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.printText in class BaseMarkupSerializerchars - The text to printstart - The start offsetlength - The number of characterspreserveSpace - Space preserving flagunescaped - Print unescapedjava.io.IOExceptionprotected void checkUnboundNamespacePrefixedNode(org.w3c.dom.Node node)
throws java.io.IOException
checkUnboundNamespacePrefixedNode in class BaseMarkupSerializernode - The node to check for unbound namespace preficesjava.io.IOExceptionpublic boolean reset()
reset in class BaseMarkupSerializerCopyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.