|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xml.serialize.BaseMarkupSerializer
org.apache.xml.serialize.XMLSerializer
org.apache.xml.serialize.XML11Serializer
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
org.w3c.dom.ls.DOMSerializer
and
serializing with org.w3c.dom.ls.DOMSerializer#write
,
org.w3c.dom.ls.DOMSerializer#writeToString
.
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 org.apache.xerces.util.NamespaceSupport |
fLocalNSBinder
stores all namespace bindings on the current element |
protected int |
fNamespaceCounter
|
protected boolean |
fNamespaces
Controls whether namespace fixup should be performed during the serialization. |
protected org.apache.xerces.util.NamespaceSupport |
fNSBinder
stores namespaces in scope |
protected org.apache.xerces.util.SymbolTable |
fSymbolTable
symbol table for serialization |
protected static java.lang.String |
PREFIX
|
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 | |
XML11Serializer()
Constructs a new serializer. |
|
XML11Serializer(OutputFormat format)
Constructs a new serializer. |
|
XML11Serializer(java.io.OutputStream output,
OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
XML11Serializer(java.io.Writer writer,
OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
void |
characters(char[] chars,
int start,
int length)
Receive notification of character data. |
protected void |
printCDATAText(java.lang.String text)
|
protected void |
printEscaped(java.lang.String source)
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)
Called to print additional text with whitespace handling. |
protected void |
printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
|
protected void |
printXMLChar(int ch)
print text data |
boolean |
reset()
|
protected void |
surrogates(int high,
int low)
|
Methods inherited from class org.apache.xml.serialize.XMLSerializer |
checkUnboundNamespacePrefixedNode, endElement, endElement, endElementIO, getEntityRef, serializeElement, setNamespaces, setOutputFormat, startDocument, startElement, startElement |
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 org.apache.xerces.util.SymbolTable fSymbolTable
protected boolean fDOML1
protected int fNamespaceCounter
protected static final java.lang.String PREFIX
protected boolean fNamespaces
Constructor Detail |
public XML11Serializer()
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.
public XML11Serializer(OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.
public XML11Serializer(java.io.Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic XML11Serializer(java.io.OutputStream output, OutputFormat format)
output
- The output stream to useformat
- The output format to use, null for the defaultMethod Detail |
public void characters(char[] chars, int start, int length) throws org.xml.sax.SAXException
org.xml.sax.ContentHandler
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Individual characters may consist of more than one Java
char
value. There are two important cases where this
happens, because characters can't be represented in just sixteen bits.
In one case, characters are represented in a Surrogate Pair,
using two special Unicode values. Such characters are in the so-called
"Astral Planes", with a code point above U+FFFF. A second case involves
composite characters, such as a base character combining with one or
more accent characters.
Your code should not assume that algorithms using
char
-at-a-time idioms will be working in character
units; in some cases they will split characters. This is relevant
wherever XML permits arbitrary characters, such as attribute values,
processing instruction data, and comments as well as in data reported
from this method. It's also generally relevant whenever Java code
manipulates internationalized text; the issue isn't unique to XML.
Note that some parsers will report whitespace in element
content using the ignorableWhitespace
method rather than this one (validating parsers must
do so).
characters
in interface org.xml.sax.ContentHandler
characters
in class BaseMarkupSerializer
org.xml.sax.SAXException
protected void printEscaped(java.lang.String source) throws java.io.IOException
BaseMarkupSerializer
printEscaped
in class XMLSerializer
java.io.IOException
protected final void printCDATAText(java.lang.String text) throws java.io.IOException
printCDATAText
in class BaseMarkupSerializer
java.io.IOException
protected final void printXMLChar(int ch) throws java.io.IOException
XMLSerializer
printXMLChar
in class XMLSerializer
java.io.IOException
protected final void surrogates(int high, int low) throws java.io.IOException
surrogates
in class BaseMarkupSerializer
java.io.IOException
protected void printText(java.lang.String text, boolean preserveSpace, boolean unescaped) throws java.io.IOException
printText
in class XMLSerializer
java.io.IOException
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws java.io.IOException
BaseMarkupSerializer
BaseMarkupSerializer.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 XMLSerializer
java.io.IOException
public boolean reset()
reset
in class XMLSerializer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |