APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.serialize

public Class HTMLSerializer

extends BaseMarkupSerializer
Class Inheritance
Known Direct Subclasses
com.sun.org.apache.xml.internal.serialize.XHTMLSerializer
Annotations
@Deprecated
Imports
com.sun.org.apache.xerces.internal.dom.DOMMessageFormatter, java.io.IOException, .OutputStream, .Writer, java.util.Enumeration, .Locale, .Map, org.w3c.dom.Attr, .Element, .NamedNodeMap, .Node, org.xml.sax.AttributeList, .Attributes, .SAXException

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.

Implements an HTML/XHTML serializer supporting both DOM and SAX pretty serializing. HTML/XHTML mode is determined in the constructor. 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. 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.xml.sax.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.

XHTML is slightly different than HTML:

Author
Assaf Arkin
See Also
Serializer

Field Summary

Modifier and TypeField and Description
private boolean
_xhtml

True if serializing in XHTML format.

private String
public static final String
Inherited from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer:
_docTypePublicId_docTypeSystemId_encodingInfo_format_indenting_prefixes_printer_startedfCurrentNodefDOMErrorfDOMErrorHandlerfDOMFilterfeaturesfStrBuffer

Constructor Summary

AccessConstructor 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
HTMLSerializer()

Constructs a new serializer.

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.

Method Summary

Modifier and TypeMethod and Description
public void
protected void
characters(String text)

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.characters.

Called to print the text contents in the prevailing element format.

public void
endElement(String namespaceURI, String localName, String rawName)

Implements org.xml.sax.ContentHandler.endElement.

Receive notification of the end of an element.

public void
endElement(String tagName)

Implements org.xml.sax.DocumentHandler.endElement.

Receive notification of the end of an element.

public void
endElementIO(String namespaceURI, String localName, String rawName)

protected String
protected String
getEntityRef(int ch)

Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef.

Returns the suitable entity reference for this character value, or null if no such entity exists.

protected void
public void
setOutputFormat(OutputFormat format)

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.setOutputFormat.

Implements com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat.

References Deprecated OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

Specifies an output format for this serializer.

public void
setXHTMLNamespace(String newNamespace)

protected void
startDocument(String rootTagName)

Called to serialize the document's DOCTYPE by the root element.

public void
startElement(String namespaceURI, String localName, String rawName, Attributes attrs)

Implements org.xml.sax.ContentHandler.startElement.

Receive notification of the beginning of an element.

public void
startElement(String tagName, AttributeList attrs)

Implements org.xml.sax.DocumentHandler.startElement.

References Deprecated AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

Receive notification of the beginning of an element.

Inherited from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer:
asContentHandlerasDocumentHandlerasDOMSerializerattributeDeclcheckUnboundNamespacePrefixedNodecleanupclearDocumentStatecommentcommentcontentelementDeclendCDATAendDocumentendDTDendEntityendNonEscapingendPrefixMappingendPreservingenterElementStateexternalEntityDeclfatalErrorgetElementStategetPrefixignorableWhitespaceinternalEntityDeclisDocumentStateleaveElementStatemodifyDOMErrornotationDeclprepareprintCDATATextprintDoctypeURLprintEscapedprintEscapedprintHexprintTextprintTextprocessingInstructionprocessingInstructionIOresetserializeserializeserializeserializeserializeDocumentserializeDTDserializeNodeserializePreRootsetDocumentLocatorsetOutputByteStreamsetOutputCharStreamskippedEntitystartCDATAstartDocumentstartDTDstartEntitystartNonEscapingstartPrefixMappingstartPreservingsurrogatesunparsedEntityDecl

Field Detail

_xhtmlback to summary
private boolean _xhtml

True if serializing in XHTML format.

fUserXHTMLNamespaceback to summary
private String fUserXHTMLNamespace
XHTMLNamespaceback to summary
public static final String XHTMLNamespace

Constructor Detail

HTMLSerializerback to summary
protected HTMLSerializer(boolean xhtml, OutputFormat format)

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

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 setOutputCharStream or setOutputByteStream first.

Parameters
xhtml:boolean

True if XHTML serializing

HTMLSerializerback to summary
public HTMLSerializer()

Constructs a new serializer. The serializer cannot be used without calling setOutputCharStream or setOutputByteStream first.

HTMLSerializerback to summary
public HTMLSerializer(OutputFormat format)

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a new serializer. The serializer cannot be used without calling setOutputCharStream or setOutputByteStream first.

HTMLSerializerback to summary
public HTMLSerializer(Writer writer, OutputFormat format)

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

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.

Parameters
writer:Writer

The writer to use

format:OutputFormat

The output format to use, null for the default

HTMLSerializerback to summary
public HTMLSerializer(OutputStream output, OutputFormat format)

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

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.

Parameters
output:OutputStream

The output stream to use

format:OutputFormat

The output format to use, null for the default

Method Detail

charactersback to summary
public void characters(char[] chars, int start, int length) throws SAXException

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.characters.

Implements org.xml.sax.ContentHandler.characters, org.xml.sax.DocumentHandler.characters.

Doc from org.xml.sax.ContentHandler.characters.

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 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).

Exceptions
SAXException:
any SAX exception, possibly wrapping another exception
charactersback to summary
protected void characters(String text) throws IOException

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.characters.

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.characters.

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.

Exceptions
IOException:
An I/O exception occured while serializing
endElementback to summary
public void endElement(String namespaceURI, String localName, String rawName) throws SAXException

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.ContentHandler.endElement.

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).

For information on the names, see startElement.

Exceptions
SAXException:
any SAX exception, possibly wrapping another exception
endElementback to summary
public void endElement(String tagName) throws SAXException

Implements org.xml.sax.DocumentHandler.endElement.

Doc from org.xml.sax.DocumentHandler.endElement.

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.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
endElementIOback to summary
public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException
escapeURIback to summary
protected String escapeURI(String uri)
getEntityRefback to summary
protected String getEntityRef(int ch)

Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef.

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef.

Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".

serializeElementback to summary
protected void serializeElement(Element elem) throws IOException

Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement.

Called to serialize a DOM element. Equivalent to calling startElement, endElement and serializing everything inbetween, but better optimized.

Exceptions
IOException:

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement.

An I/O exception occured while serializing

setOutputFormatback to summary
public void setOutputFormat(OutputFormat format)

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.setOutputFormat.

Implements com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat.

Doc from com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat.

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

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.

setXHTMLNamespaceback to summary
public void setXHTMLNamespace(String newNamespace)
startDocumentback 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 (_started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see serializePreRoot). Pre-root will be serialized even if this is not the first root element of the document.

startElementback to summary
public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.ContentHandler.startElement.

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.

This event allows up to three name components for each element:

  1. the Namespace URI;
  2. the local name; and
  3. the qualified (prefixed) name.

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:

  • the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
  • the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

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.

Exceptions
SAXException:
any SAX exception, possibly wrapping another exception
startElementback to summary
public void startElement(String tagName, AttributeList attrs) throws SAXException

Implements org.xml.sax.DocumentHandler.startElement.

Doc from org.xml.sax.DocumentHandler.startElement.

References Deprecated

AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

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.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.