Package org.custommonkey.xmlunit

Class HTMLDocumentBuilder

java.lang.Object

org.custommonkey.xmlunit.HTMLDocumentBuilder

public class HTMLDocumentBuilder
extends Object

Build a DOM document from HTML content converting from 'plain' HTML into 'XHTML' along the way with the help of a TolerantSaxDocumentBuilder and the Swing html parser classes. This allows XML assertions to be made against badly formed HTML.

See Also:

• TolerantSaxDocumentBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	HTMLDocumentBuilder.SwingEvent2SaxAdapter	Adapts Swing HTML callback messages to Sax equivalents, passing them to a Sax-aware ContentHandler.

Field Summary

Fields

Modifier and Type	Field	Description
protected final HTMLDocumentBuilder.SwingEvent2SaxAdapter	swingEvent2SaxAdapter
protected final TolerantSaxDocumentBuilder	tolerantSaxDocumentBuilder
private final StringBuilder	traceBuilder

Constructor Summary

Constructors

Constructor	Description
HTMLDocumentBuilder(TolerantSaxDocumentBuilder tolerantSaxDocumentBuilder)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getTrace()
Document	parse(Reader reader)
Document	parse(String htmlString)
private void	trace(String msg)	Append to the log built up during parsing

Methods inherited from class java.lang.Object

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

Field Details

tolerantSaxDocumentBuilder

protected final TolerantSaxDocumentBuilder tolerantSaxDocumentBuilder

swingEvent2SaxAdapter

protected final HTMLDocumentBuilder.SwingEvent2SaxAdapter swingEvent2SaxAdapter

traceBuilder

private final StringBuilder traceBuilder

Constructor Details

HTMLDocumentBuilder

public HTMLDocumentBuilder(TolerantSaxDocumentBuilder tolerantSaxDocumentBuilder)

Constructor

Parameters:

tolerantSaxDocumentBuilder - the instance that will receive SAX calls generated as the HTML is parsed and build up a DOM Document

Method Details

parse

public Document parse(Reader reader)
               throws SAXException,
IOException

Returns:

a DOM document parsed from the Reader via an SwingEvent2SaxAdapter and TolerantSaxBuilder. Not thread-safe!

Throws:

SAXException

IOException

See Also:

• TolerantSaxDocumentBuilder

parse

public Document parse(String htmlString)
               throws SAXException,
IOException

Returns:

a DOM document parsed from the String via an SwingEvent2SaxAdapter and TolerantSaxBuilder. Not thread-safe!

Throws:

SAXException

IOException

See Also:

• TolerantSaxDocumentBuilder

getTrace

public String getTrace()

Returns:

the trace of events and / or warnings encountered during parsing

trace

private void trace(String msg)

Append to the log built up during parsing

Parameters:

msg - what to append