Package nu.validator.xml

Class HtmlSerializer

java.lang.Object

nu.validator.xml.HtmlSerializer

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class HtmlSerializer
extends java.lang.Object
implements org.xml.sax.ContentHandler

Serializes a sequence of SAX events representing an XHTML 1.0 Strict document to an OutputStream as a UTF-8-encoded HTML 4.01 Strict document. The SAX events must represent a valid XHTML 1.0 document, except the namespace prefixes don't matter and there may be startElement and endElement calls for elements from other namespaces. The startElement and endElement calls for non-XHTML elements are ignored. No validity checking is performed. Hence, the emitter of the SAX events is responsible for making sure the events represent a document that meets the above requirements. The OutputStream is closed when the end of the document is seen.

Version:

$Id$

Author:

hsivonen, taavi

Field Summary

Fields

Modifier and Type	Field	Description
static int	DOCTYPE_HTML401_STRICT
static int	DOCTYPE_HTML401_TRANSITIONAL
static int	DOCTYPE_HTML5
static int	NO_DOCTYPE
protected java.io.Writer	writer	The writer used for output

Constructor Summary

Constructors

Constructor	Description
HtmlSerializer(java.io.OutputStream out)	Creates a new instance of HtmlSerializer in the HTML 4.01 doctype mode with the UTF-8 encoding and no charset meta.
HtmlSerializer(java.io.OutputStream out, int doctype, boolean emitMeta)
HtmlSerializer(java.io.OutputStream out, int doctype, boolean emitMeta, java.lang.String enc)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Writes out characters.
void	endDocument()	Must be called in the end.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)	Writes an end tag if the element is an XHTML element and is not an empty element in HTML 4.01 Strict.
void	endPrefixMapping(java.lang.String str)	Does nothing.
void	ignorableWhitespace(char[] values, int param, int param2)	Does nothing.
static void	main(java.lang.String[] args)	Used for testing.
void	processingInstruction(java.lang.String str, java.lang.String str1)	Does nothing.
void	setDocumentLocator(org.xml.sax.Locator locator)	Does nothing.
void	skippedEntity(java.lang.String str)	Does nothing.
void	startDocument()	Must be called first.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)	Writes a start tag if the element is an XHTML element.
void	startPrefixMapping(java.lang.String str, java.lang.String str1)	Does nothing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_DOCTYPE

public static final int NO_DOCTYPE

See Also:

Constant Field Values

DOCTYPE_HTML401_TRANSITIONAL

public static final int DOCTYPE_HTML401_TRANSITIONAL

See Also:

Constant Field Values

DOCTYPE_HTML401_STRICT

public static final int DOCTYPE_HTML401_STRICT

See Also:

Constant Field Values

DOCTYPE_HTML5

public static final int DOCTYPE_HTML5

See Also:

Constant Field Values

writer

protected java.io.Writer writer

The writer used for output

Constructor Detail

HtmlSerializer

public HtmlSerializer(java.io.OutputStream out)

Creates a new instance of HtmlSerializer in the HTML 4.01 doctype mode with the UTF-8 encoding and no charset meta.

Parameters:

out - the stream to which the output is written

HtmlSerializer

public HtmlSerializer(java.io.OutputStream out,
                      int doctype,
                      boolean emitMeta)

HtmlSerializer

public HtmlSerializer(java.io.OutputStream out,
                      int doctype,
                      boolean emitMeta,
                      java.lang.String enc)

Method Detail

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Writes out characters.

Specified by:

characters in interface org.xml.sax.ContentHandler

Parameters:

ch - the source array

start - the index of the first character to be written

length - the number of characters to write

Throws:

org.xml.sax.SAXException - if there are IO problems

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Must be called in the end.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - if there are IO problems

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Writes an end tag if the element is an XHTML element and is not an empty element in HTML 4.01 Strict.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Parameters:

namespaceURI - the XML namespace

localName - the element name in the namespace

qName - ignored

Throws:

org.xml.sax.SAXException - if there are IO problems

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Must be called first.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Writes a start tag if the element is an XHTML element.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Parameters:

namespaceURI - the XML namespace

localName - the element name in the namespace

qName - ignored

atts - the attribute list

Throws:

org.xml.sax.SAXException - if there are IO problems

main

public static void main(java.lang.String[] args)

Used for testing. Pass a file:// URL as the command line argument.

endPrefixMapping

public void endPrefixMapping(java.lang.String str)
                      throws org.xml.sax.SAXException

Does nothing.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] values,
                                int param,
                                int param2)
                         throws org.xml.sax.SAXException

Does nothing.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String str,
                                  java.lang.String str1)
                           throws org.xml.sax.SAXException

Does nothing.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Does nothing.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String str)
                   throws org.xml.sax.SAXException

Does nothing.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String str,
                               java.lang.String str1)
                        throws org.xml.sax.SAXException

Does nothing.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException