java.lang.Object | |
↳ | org.apache.xml.serialize.BaseMarkupSerializer |
Known Direct Subclasses |
Known Indirect Subclasses |
This class is deprecated.
This class was deprecated in Xerces 2.9.0. It is recommended
that new applications use the DOM Level 3 LSSerializer or JAXP's Transformation
API for XML (TrAX) for serializing XML. See the Xerces documentation for more
information.
Base class for a serializer supporting both DOM and SAX pretty serializing of XML/HTML/XHTML documents. Derives classes perform the method-specific serializing, this class provides the common serializing mechanisms.
The serializer must be initialized with the proper writer and
output format before it can be used by calling setOutputCharStream(Writer)
or setOutputByteStream(OutputStream)
for the writer and setOutputFormat(OutputFormat)
for the output format.
The serializer can be reused any number of times, but cannot be used concurrently by two threads.
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. DOM serializing is done
by calling serialize(Document)
and SAX serializing is done by firing
SAX events and using the serializer as a document handler.
This also applies to derived class.
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 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.
When indenting, the serializer is capable of detecting seemingly element content, and serializing these elements indented on separate lines. An element is serialized indented when it is the first or last child of an element, or immediate following or preceding another element.
Serializer
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
_docTypePublicId | The system identifier of the document type, if known. | ||||||||||
_docTypeSystemId | The system identifier of the document type, if known. | ||||||||||
_encodingInfo | |||||||||||
_format | The output format associated with this serializer. | ||||||||||
_indenting | True if indenting printer. | ||||||||||
_prefixes | Association between namespace URIs (keys) and prefixes (values). | ||||||||||
_printer | The printer used for printing text parts. | ||||||||||
_started | If the document has been started (header serialized), this flag is set to true so it's not started twice. | ||||||||||
fCurrentNode | Current node that is being processed | ||||||||||
fDOMError | |||||||||||
fDOMErrorHandler | |||||||||||
fDOMFilter | |||||||||||
fStrBuffer | Temporary buffer to store character data | ||||||||||
features |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Protected constructor can only be used by derived class.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return a ContentHandler interface into this serializer.
| |||||||||||
Return a
DOMSerializer interface into this serializer. | |||||||||||
Return a DocumentHandler interface into this serializer.
| |||||||||||
Called at the end of the document to wrap it up.
| |||||||||||
Serializes the DOM element using the previously specified
writer and output format.
| |||||||||||
Serializes the DOM document using the previously specified
writer and output format.
| |||||||||||
Serializes the DOM document fragmnt using the previously specified
writer and output format.
| |||||||||||
Specifies an output stream to which the document should be
serialized.
| |||||||||||
Specifies a writer to which the document should be serialized.
| |||||||||||
Specifies an output format for this serializer.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Called to print the text contents in the prevailing element format.
| |||||||||||
DOM level 3:
Check a node to determine if it contains unbound namespace prefixes.
| |||||||||||
Must be called by a method about to print any type of content.
| |||||||||||
Enter a new element state for the specified element.
| |||||||||||
Return the state of the current element.
| |||||||||||
Returns the suitable entity reference for this character value,
or null if no such entity exists.
| |||||||||||
Returns the namespace prefix for the specified URI.
| |||||||||||
Returns true if in the state of the document.
| |||||||||||
Leave the current element state and return to the
state of the parent element.
| |||||||||||
The method modifies global DOM error object
| |||||||||||
Print a document type public or system identifier URL.
| |||||||||||
Escapes a string so it may be printed as text content or attribute
value.
| |||||||||||
Called to print additional text with whitespace handling.
| |||||||||||
Called to serializee the DOM element.
| |||||||||||
Serialize the DOM node.
| |||||||||||
Comments and PIs cannot be serialized before the root element,
because the root element serializes the document type, which
generally comes first.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.xml.serialize.DOMSerializer
| |||||||||||
From interface
org.apache.xml.serialize.Serializer
| |||||||||||
From interface
org.xml.sax.ContentHandler
| |||||||||||
From interface
org.xml.sax.DTDHandler
| |||||||||||
From interface
org.xml.sax.DocumentHandler
| |||||||||||
From interface
org.xml.sax.ext.DeclHandler
| |||||||||||
From interface
org.xml.sax.ext.LexicalHandler
|
The output format associated with this serializer. This will never be a null reference. If no format was passed to the constructor, the default one for this document type will be used. The format object is never changed by the serializer.
True if indenting printer.
Association between namespace URIs (keys) and prefixes (values). Accumulated here prior to starting an element and placing this list in the element state.
If the document has been started (header serialized), this flag is set to true so it's not started twice.
Current node that is being processed
Protected constructor can only be used by derived class.
Must initialize the serializer before serializing any document,
by calling setOutputCharStream(Writer)
or setOutputByteStream(OutputStream)
first
Return a ContentHandler interface into this serializer. If the serializer does not support the ContentHandler interface, it should return null.
IOException |
---|
Return a DOMSerializer
interface into this serializer.
If the serializer does not support the DOMSerializer
interface, it should return null.
IOException |
---|
Return a DocumentHandler interface into this serializer. If the serializer does not support the DocumentHandler interface, it should return null.
IOException |
---|
SAXException |
---|
SAXException |
---|
SAXException |
---|
Called at the end of the document to wrap it up. Will flush the output stream and throw an exception if any I/O error occured while serializing.
SAXException | An I/O exception occured during serializing |
---|
SAXException |
---|
Serializes the DOM element using the previously specified writer and output format. Throws an exception only if an I/O exception occured while serializing.
elem | The element to serialize |
---|
IOException | An I/O exception occured while serializing |
---|
Serializes the DOM document using the previously specified writer and output format. Throws an exception only if an I/O exception occured while serializing.
doc | The document to serialize |
---|
IOException | An I/O exception occured while serializing |
---|
Serializes the DOM document fragmnt using the previously specified writer and output format. Throws an exception only if an I/O exception occured while serializing.
frag | The document fragment to serialize |
---|
IOException | An I/O exception occured while serializing |
---|
Specifies an output stream to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.
Specifies a writer to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.
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.
format | The output format to use |
---|
SAXException |
---|
SAXException |
---|
Called to print the text contents in the prevailing element format. Since this method is capable of printing text as CDATA, it is used for that purpose as well. White space handling is determined by the current element state. In addition, the output format can dictate whether the text is printed as CDATA or unescaped.
text | The text to print |
---|
IOException | An I/O exception occured while serializing |
---|
DOM level 3: Check a node to determine if it contains unbound namespace prefixes.
node | The node to check for unbound namespace prefices |
---|
IOException |
---|
Must be called by a method about to print any type of content. If the element was just opened, the opening tag is closed and will be matched to a closing tag. Returns the current element state with empty and afterElement set to false.
IOException | An I/O exception occurred while serializing |
---|
Enter a new element state for the specified element. Tag name and space preserving is specified, element state is initially empty.
Return the state of the current element.
Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".
ch | Character value |
---|
Returns the namespace prefix for the specified URI. If the URI has been mapped to a prefix, returns the prefix, otherwise returns null.
namespaceURI | The namespace URI |
---|
Returns true if in the state of the document. Returns true before entering any element and after leaving the root element.
Leave the current element state and return to the state of the parent element. If this was the root element, return to the state of the document.
The method modifies global DOM error object
Print a document type public or system identifier URL.
Encapsulates the URL in double quotes, escapes non-printing
characters and print it equivalent to printText(char[], int, int, boolean, boolean)
.
url | The document type url to print |
---|
IOException |
---|
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. <).
source | The string to escape |
---|
IOException |
---|
Called to print additional text with whitespace handling.
If spaces are preserved, the text is printed as if by calling
printText(String, boolean, boolean)
with a call to 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.
chars | The text to print |
---|---|
start | The start offset |
length | The number of characters |
preserveSpace | Space preserving flag |
unescaped | Print unescaped |
IOException |
---|
Called to serializee the DOM element. The element is serialized based on the serializer's method (XML, HTML, XHTML).
elem | The element to serialize |
---|
IOException | An I/O exception occured while serializing |
---|
Serialize the DOM node. This method is shared across XML, HTML and XHTML
serializers and the differences are masked out in a separate serializeElement(Element)
.
node | The node to serialize |
---|
IOException | An I/O exception occured while serializing |
---|
Comments and PIs cannot be serialized before the root element, because the root element serializes the document type, which generally comes first. Instead such PIs and comments are accumulated inside a vector and serialized by calling this method. Will be called when the root element is serialized and when the document finished serializing.
IOException | An I/O exception occured while serializing |
---|