Class XML11Serializer
- All Implemented Interfaces:
DOMSerializer
,Serializer
,ContentHandler
,DocumentHandler
,DTDHandler
,DeclHandler
,LexicalHandler
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: 476047 $ $Date: 2006-11-17 09:57:45 +0530 (Fri, 17 Nov 2006) $
- Author:
- Assaf Arkin, Rahul Srivastava, Elena Litani IBM
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final boolean
Deprecated.protected boolean
Deprecated.protected org.apache.xerces.util.NamespaceSupport
Deprecated.stores all namespace bindings on the current elementprotected int
Deprecated.protected 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.XMLSerializer
fNamespacePrefixes
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.XML11Serializer
(OutputStream output, OutputFormat format) Deprecated.Constructs a new serializer that writes to the specified output stream using the specified output format.XML11Serializer
(Writer writer, OutputFormat format) Deprecated.Constructs a new serializer that writes to the specified writer using the specified output format.XML11Serializer
(OutputFormat format) Deprecated.Constructs a new serializer. -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(char[] chars, int start, int length) Deprecated.protected final void
printCDATAText
(String text) Deprecated.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 final void
printXMLChar
(int ch) Deprecated.print text databoolean
reset()
Deprecated.protected final void
surrogates
(int high, int low, boolean inContent) Deprecated.Methods inherited from class org.apache.xml.serialize.XMLSerializer
checkUnboundNamespacePrefixedNode, endElement, endElement, endElementIO, getEntityRef, serializeElement, setNamespaces, setOutputFormat, startDocument, startElement, startElement
Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, 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, printDoctypeURL, printEscaped, processingInstruction, processingInstructionIO, serialize, serialize, serialize, serializeNode, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, 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 -
fDOML1
protected boolean fDOML1Deprecated. -
fNamespaceCounter
protected int fNamespaceCounterDeprecated. -
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, fNamespaceCounter.
-
-
Constructor Details
-
XML11Serializer
public XML11Serializer()Deprecated.Constructs a new serializer. The serializer cannot be used without callingBaseMarkupSerializer.setOutputCharStream(java.io.Writer)
orBaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first. -
XML11Serializer
Deprecated.Constructs a new serializer. The serializer cannot be used without callingBaseMarkupSerializer.setOutputCharStream(java.io.Writer)
orBaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first. -
XML11Serializer
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
-
XML11Serializer
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
-
characters
Deprecated.- Specified by:
characters
in interfaceContentHandler
- Specified by:
characters
in interfaceDocumentHandler
- Overrides:
characters
in classBaseMarkupSerializer
- Throws:
SAXException
-
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 classXMLSerializer
- Parameters:
source
- The string to escape- Throws:
IOException
-
printCDATAText
Deprecated.- Overrides:
printCDATAText
in classBaseMarkupSerializer
- Throws:
IOException
-
printXMLChar
Deprecated.Description copied from class:XMLSerializer
print text data- Overrides:
printXMLChar
in classXMLSerializer
- Throws:
IOException
-
surrogates
Deprecated.- Overrides:
surrogates
in classBaseMarkupSerializer
- Throws:
IOException
-
printText
Deprecated.- Overrides:
printText
in classXMLSerializer
- 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 classXMLSerializer
- Parameters:
chars
- The text to printstart
- The start offsetlength
- The number of characterspreserveSpace
- Space preserving flagunescaped
- Print unescaped- Throws:
IOException
-
reset
public boolean reset()Deprecated.- Overrides:
reset
in classXMLSerializer
-