public class HTMLSerializer extends BaseMarkupSerializer
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 BaseMarkupSerializer.serialize(org.w3c.dom.Element)
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 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:
Serializer
Modifier and Type | Field and Description |
---|---|
static String |
XHTMLNamespace
Deprecated.
|
_docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fCurrentNode, fDOMError, fDOMErrorHandler, fDOMFilter, features, fStrBuffer
Modifier | Constructor and Description |
---|---|
|
HTMLSerializer()
Deprecated.
Constructs a new serializer.
|
protected |
HTMLSerializer(boolean xhtml,
OutputFormat format)
Deprecated.
Constructs a new HTML/XHTML serializer depending on the value of
xhtml.
|
|
HTMLSerializer(OutputFormat format)
Deprecated.
Constructs a new serializer.
|
|
HTMLSerializer(OutputStream output,
OutputFormat format)
Deprecated.
Constructs a new serializer that writes to the specified output
stream using the specified output format.
|
|
HTMLSerializer(Writer writer,
OutputFormat format)
Deprecated.
Constructs a new serializer that writes to the specified writer
using the specified output format.
|
Modifier and Type | Method and Description |
---|---|
void |
characters(char[] chars,
int start,
int length)
Deprecated.
|
protected void |
characters(String text)
Deprecated.
Called to print the text contents in the prevailing element format.
|
void |
endElement(String tagName)
Deprecated.
|
void |
endElement(String namespaceURI,
String localName,
String rawName)
Deprecated.
|
void |
endElementIO(String namespaceURI,
String localName,
String rawName)
Deprecated.
|
protected String |
escapeURI(String uri)
Deprecated.
|
protected String |
getEntityRef(int ch)
Deprecated.
Returns the suitable entity reference for this character value,
or null if no such entity exists.
|
protected void |
serializeElement(Element elem)
Deprecated.
Called to serialize a DOM element.
|
void |
setOutputFormat(OutputFormat format)
Deprecated.
Specifies an output format for this serializer.
|
void |
setXHTMLNamespace(String newNamespace)
Deprecated.
|
protected void |
startDocument(String rootTagName)
Deprecated.
Called to serialize the document's DOCTYPE by the root element.
|
void |
startElement(String tagName,
AttributeList attrs)
Deprecated.
|
void |
startElement(String namespaceURI,
String localName,
String rawName,
Attributes attrs)
Deprecated.
|
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, checkUnboundNamespacePrefixedNode, cleanup, comment, comment, content, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, printEscaped, printText, printText, processingInstruction, processingInstructionIO, reset, serialize, serialize, serialize, serializeNode, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, surrogates, unparsedEntityDecl
public static final String XHTMLNamespace
protected HTMLSerializer(boolean xhtml, OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.xhtml
- True if XHTML serializingpublic HTMLSerializer()
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public HTMLSerializer(OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public HTMLSerializer(Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic HTMLSerializer(OutputStream output, OutputFormat format)
output
- The output stream to useformat
- The output format to use, null for the defaultpublic void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
setOutputFormat
in class BaseMarkupSerializer
format
- The output format to usepublic void setXHTMLNamespace(String newNamespace)
public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException
SAXException
public void endElement(String namespaceURI, String localName, String rawName) throws SAXException
SAXException
public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException
IOException
public void characters(char[] chars, int start, int length) throws SAXException
characters
in interface ContentHandler
characters
in interface DocumentHandler
characters
in class BaseMarkupSerializer
SAXException
public void startElement(String tagName, AttributeList attrs) throws SAXException
SAXException
public void endElement(String tagName) throws SAXException
SAXException
protected void startDocument(String rootTagName) throws IOException
This method will check if it has not been called before (BaseMarkupSerializer._started
),
will serialize the document type declaration, and will serialize all
pre-root comments and PIs that were accumulated in the document
(see BaseMarkupSerializer.serializePreRoot()
). Pre-root will be serialized even if
this is not the first root element of the document.
IOException
protected void serializeElement(Element elem) throws IOException
startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
, endElement(java.lang.String, java.lang.String, java.lang.String)
and serializing everything
inbetween, but better optimized.serializeElement
in class BaseMarkupSerializer
elem
- The element to serializeIOException
- An I/O exception occured while
serializingprotected void characters(String text) throws IOException
BaseMarkupSerializer
characters
in class BaseMarkupSerializer
text
- The text to printIOException
- An I/O exception occured while
serializingprotected String getEntityRef(int ch)
BaseMarkupSerializer
getEntityRef
in class BaseMarkupSerializer
ch
- Character valueCopyright © 2017 JBoss by Red Hat. All rights reserved.