Deprecated
This class was deprecated in Xerces 2.6.2. It is recommended that new applications use JAXP's Transformation API for XML (TrAX) for serializing HTML. See the Xerces documentation for more information.
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. DOM serializing is done
by calling serialize and SAX serializing is done by firing
SAX events and using the serializer as a document handler.
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 org..
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.
XHTML is slightly different than HTML:
Serializer
| Modifier and Type | Field and Description |
|---|---|
| private boolean | _xhtml
True if serializing in XHTML format. |
| private String | |
| public static final String |
| Access | Constructor and Description |
|---|---|
| protected | HTMLSerializer(boolean
True if XHTML serializing xhtml, OutputFormat format)
References Deprecated
OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.
Constructs a new HTML/XHTML serializer depending on the value of xhtml. |
| public | |
| public | HTMLSerializer(OutputFormat format)
References Deprecated
OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.
Constructs a new serializer. |
| public | HTMLSerializer(Writer
The writer to use writer, OutputFormat The output format to use, null for the default format)
References Deprecated
OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.
Constructs a new serializer that writes to the specified writer using the specified output format. |
| public | HTMLSerializer(OutputStream
The output stream to use output, OutputFormat The output format to use, null for the default format)
References Deprecated
OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.
Constructs a new serializer that writes to the specified output stream using the specified output format. |
| Modifier and Type | Method and Description |
|---|---|
| public void | characters(char[] chars, int start, int length)
Overrides com. Implements org. Receive notification of character data. |
| protected void | characters(String text)
Overrides com. Called to print the text contents in the prevailing element format. |
| public void | endElement(String namespaceURI, String localName, String rawName)
Implements org. Receive notification of the end of an element. |
| public void | endElement(String tagName)
Implements org. Receive notification of the end of an element. |
| public void | |
| protected String | |
| protected String | getEntityRef(int ch)
Implements abstract com. Returns the suitable entity reference for this character value, or null if no such entity exists. |
| protected void | serializeElement(Element elem)
Implements abstract com. Called to serialize a DOM element. |
| public void | setOutputFormat(OutputFormat format)
Overrides com. Implements com.
References Deprecated
OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.
Specifies an output format for this serializer. |
| public void | |
| protected void | |
| public void | startElement(String namespaceURI, String localName, String rawName, Attributes attrs)
Implements org. Receive notification of the beginning of an element. |
| public void | startElement(String tagName, AttributeList attrs)
Implements org.
References Deprecated
AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.
Receive notification of the beginning of an element. |
| _xhtml | back to summary |
|---|---|
| private boolean _xhtml True if serializing in XHTML format. | |
| fUserXHTMLNamespace | back to summary |
|---|---|
| private String fUserXHTMLNamespace | |
| XHTMLNamespace | back to summary |
|---|---|
| public static final String XHTMLNamespace | |
| HTMLSerializer | back to summary |
|---|---|
| protected HTMLSerializer(boolean xhtml, OutputFormat format)
References Deprecated
See corresponding docs for further information. Constructs a new HTML/XHTML serializer depending on the value of
xhtml. The serializer cannot be used without calling
| |
| HTMLSerializer | back to summary |
|---|---|
| public HTMLSerializer() Constructs a new serializer. The serializer cannot be used without
calling | |
| HTMLSerializer | back to summary |
|---|---|
| public HTMLSerializer(OutputFormat format)
References Deprecated
See corresponding docs for further information. Constructs a new serializer. The serializer cannot be used without
calling | |
| HTMLSerializer | back to summary |
|---|---|
| public HTMLSerializer(Writer writer, OutputFormat format)
References Deprecated
See corresponding docs for further information. 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.
| |
| HTMLSerializer | back to summary |
|---|---|
| public HTMLSerializer(OutputStream output, OutputFormat format)
References Deprecated
See corresponding docs for further information. 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.
| |
| characters | back to summary |
|---|---|
| public void characters(char[] chars, int start, int length) throws SAXException Overrides com. Implements org. Doc from org. Receive notification of character data. 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
Your code should not assume that algorithms using
Note that some parsers will report whitespace in element
content using the
| |
| characters | back to summary |
|---|---|
| protected void characters(String text) throws IOException Overrides com. Doc from com. 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.
| |
| endElement | back to summary |
|---|---|
| public void endElement(String namespaceURI, String localName, String rawName) throws SAXException Implements org. Doc from org. Receive notification of the end of an element. The SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
For information on the names, see startElement.
| |
| endElement | back to summary |
|---|---|
| public void endElement(String tagName) throws SAXException Implements org. Doc from org. Receive notification of the end of an element. The 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.
| |
| endElementIO | back to summary |
|---|---|
| public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException | |
| escapeURI | back to summary |
|---|---|
| protected String escapeURI(String uri) | |
| getEntityRef | back to summary |
|---|---|
| protected String getEntityRef(int ch) Implements abstract com. Doc from com. Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&". | |
| serializeElement | back to summary |
|---|---|
| protected void serializeElement(Element elem) throws IOException Implements abstract com. Called to serialize a DOM element. Equivalent to calling
| |
| setOutputFormat | back to summary |
|---|---|
| public void setOutputFormat(OutputFormat format) Overrides com. Implements com. Doc from com. References Deprecated
See corresponding docs for further information. 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. | |
| setXHTMLNamespace | back to summary |
|---|---|
| public void setXHTMLNamespace(String newNamespace) | |
| startDocument | back to summary |
|---|---|
| protected void startDocument(String rootTagName) throws IOException 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 ( | |
| startElement | back to summary |
|---|---|
| public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException Implements org. Doc from org. Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
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
Like
| |
| startElement | back to summary |
|---|---|
| public void startElement(String tagName, AttributeList attrs) throws SAXException Implements org. Doc from org. References Deprecated
See corresponding docs for further information. Receive notification of the beginning of an element. The 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.
| |