org.htmlunit.html.parser

Interface HTMLParser

All Known Implementing Classes:

HtmlUnitNekoHtmlParser

public interface HTMLParser

Interface for the parser used to parse HTML into a HtmlUnit-specific DOM (HU-DOM) tree.

Author:

Christian Sell, David K. Taylor, Chris Erskine, Ahmed Ashour, Marc Guillemot, Ethan Glasser-Camp, Sudhan Moghe, Ronald Brill, Frank Danek, Carsten Steul

Method Summary

Modifier and Type	Method and Description
ElementFactory	getElementFactory(SgmlPage page, String namespaceURI, String qualifiedName, boolean insideSvg, boolean svgSupport) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
ElementFactory	getFactory(String tagName) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
ElementFactory	getSvgFactory() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
void	parse(WebClient webClient, WebResponse webResponse, HtmlPage page, boolean xhtml, boolean createdByJavascript) Parses the WebResponse into an object tree representation.
default void	parse(WebResponse webResponse, HtmlPage page, boolean xhtml, boolean createdByJavascript) Deprecated. as of version 4.12.0; use parse(WebClient, WebResponse, HtmlPage, boolean, boolean) instead.
default void	parseFragment(DomNode parent, DomNode context, String source, boolean createdByJavascript) Deprecated. as of version 4.12.0; use parseFragment(WebClient, DomNode, DomNode, String, boolean) instead.
default void	parseFragment(DomNode parent, String source) Deprecated. as of version 4.12.0; use parseFragment(WebClient, DomNode, DomNode, String, boolean) instead.
void	parseFragment(WebClient webClient, DomNode parent, DomNode context, String source, boolean createdByJavascript) Parses the HTML content from the given string into an object tree representation.

Method Detail

getFactory

ElementFactory getFactory(String tagName)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.

Parameters:

tagName - an HTML element tag name

Returns:

a factory for creating HtmlElements representing the given tag

getSvgFactory

ElementFactory getSvgFactory()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.

Returns:

a factory for creating SvgElements representing the given tag

getElementFactory

ElementFactory getElementFactory(SgmlPage page,
                                 String namespaceURI,
                                 String qualifiedName,
                                 boolean insideSvg,
                                 boolean svgSupport)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns the pre-registered element factory corresponding to the specified tag, or an UnknownElementFactory.

Parameters:

page - the page

namespaceURI - the namespace URI

qualifiedName - the qualified name

insideSvg - is the node inside an SVG node or not

svgSupport - true if called from javascript createElementNS

Returns:

the pre-registered element factory corresponding to the specified tag, or an UnknownElementFactory

parseFragment

@Deprecated
default void parseFragment(DomNode parent,
                                        String source)
                                 throws SAXException,
                                        IOException

Deprecated. as of version 4.12.0; use parseFragment(WebClient, DomNode, DomNode, String, boolean) instead.

Parses the HTML content from the given string into an object tree representation.

Parameters:

parent - the parent for the new nodes

source - the (X)HTML to be parsed

Throws:

SAXException - if a SAX error occurs

IOException - if an IO error occurs

parseFragment

void parseFragment(WebClient webClient,
                   DomNode parent,
                   DomNode context,
                   String source,
                   boolean createdByJavascript)
            throws SAXException,
                   IOException

Parses the HTML content from the given string into an object tree representation.

Parameters:

webClient - the WebClient

parent - where the new parsed nodes will be added to

context - the context to build the fragment context stack

source - the (X)HTML to be parsed

createdByJavascript - if true the (script) tag was created by javascript

Throws:

SAXException - if a SAX error occurs

IOException - if an IO error occurs

parseFragment

@Deprecated
default void parseFragment(DomNode parent,
                                        DomNode context,
                                        String source,
                                        boolean createdByJavascript)
                                 throws SAXException,
                                        IOException

Deprecated. as of version 4.12.0; use parseFragment(WebClient, DomNode, DomNode, String, boolean) instead.

Parses the HTML content from the given string into an object tree representation.

Parameters:

parent - where the new parsed nodes will be added to

context - the context to build the fragment context stack

source - the (X)HTML to be parsed

createdByJavascript - if true the (script) tag was created by javascript

Throws:

SAXException - if a SAX error occurs

IOException - if an IO error occurs

parse

void parse(WebClient webClient,
           WebResponse webResponse,
           HtmlPage page,
           boolean xhtml,
           boolean createdByJavascript)
    throws IOException

Parses the WebResponse into an object tree representation.

Parameters:

webClient - the WebClient

webResponse - the response data

page - the HtmlPage to add the nodes

xhtml - if true use the XHtml parser

createdByJavascript - if true the (script) tag was created by javascript

Throws:

IOException - if there is an IO error

parse

@Deprecated
default void parse(WebResponse webResponse,
                                HtmlPage page,
                                boolean xhtml,
                                boolean createdByJavascript)
                         throws IOException

Deprecated. as of version 4.12.0; use parse(WebClient, WebResponse, HtmlPage, boolean, boolean) instead.

Parses the WebResponse into an object tree representation.

Parameters:

webResponse - the response data

page - the HtmlPage to add the nodes

xhtml - if true use the XHtml parser

createdByJavascript - if true the (script) tag was created by javascript

Throws:

IOException - if there is an IO error