Module io.sf.carte.css4j.dom4j

Package io.sf.carte.doc.dom4j

Class DOM4JUserAgent

java.lang.Object

io.sf.carte.doc.agent.AbstractUserAgent

io.sf.carte.doc.dom4j.DOM4JUserAgent

All Implemented Interfaces:

UserAgent, UserAgent.AgentControl, Serializable

public class DOM4JUserAgent
extends AbstractUserAgent

User Agent based on DOM4J document trees.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DOM4JUserAgent.AgentXHTMLDocumentFactory

Nested classes/interfaces inherited from interface io.sf.carte.doc.agent.UserAgent

UserAgent.AgentControl

Field Summary

Fields

Modifier and Type	Field	Description
protected EntityResolver	resolver

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DOM4JUserAgent(EnumSet<Parser.Flag> parserFlags)
protected	DOM4JUserAgent(EnumSet<Parser.Flag> parserFlags, boolean useXPP3)

Method Summary

Modifier and Type	Method	Description
protected EntityResolver	createEntityResolver()
static AbstractUserAgent	createUserAgent(EnumSet<Parser.Flag> parserFlags, boolean useXPP3)	Creates an user agent that reads XHTML documents with DOM4J.
XHTMLDocumentFactory	getXHTMLDocumentFactory()
protected InputStream	openInputStream(URLConnection con)
protected DOM4JUserAgent.AgentXHTMLDocumentFactory.AgentXHTMLDocument	parseDocument(Reader re)
XHTMLDocument	readURL(URL url)	Reads and parses an XHTML document located in the given URL.
void	setEntityResolver(EntityResolver resolver)	Sets the entity resolver to be used when parsing documents.

Methods inherited from class io.sf.carte.doc.agent.AbstractUserAgent

authenticationCredentials, createConnection, getAgentControl, getAuthenticationCredentials, getCookieConfig, getCookies, getOriginPolicy, getParserFlags, getProperty, isVisitedURL, openConnection, readCookies, setConnectionTimeout, setOriginPolicy, setProperty, setUseragentId

Methods inherited from class java.lang.Object

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

Field Details

resolver

protected EntityResolver resolver

Constructor Details

DOM4JUserAgent

protected DOM4JUserAgent(EnumSet<Parser.Flag> parserFlags)

DOM4JUserAgent

protected DOM4JUserAgent(EnumSet<Parser.Flag> parserFlags,
 boolean useXPP3)

Method Details

createUserAgent

public static AbstractUserAgent createUserAgent(EnumSet<Parser.Flag> parserFlags,
 boolean useXPP3)

Creates an user agent that reads XHTML documents with DOM4J.

Parameters:

useXPP3 - Sets the use of the XPP3 pull parser to parse the documents.

Returns:

the user agent.

createEntityResolver

protected EntityResolver createEntityResolver()

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Sets the entity resolver to be used when parsing documents.

Parameters:

resolver - the entity resolver.

readURL

public XHTMLDocument readURL(URL url)
                      throws IOException,
DocumentException

Reads and parses an XHTML document located in the given URL.

Parameters:

url - the URL that points to the document.

Returns:

the XHTMLDocument.

Throws:

IOException - if there is an I/O problem reading the URL.

DocumentException - if there is a problem parsing the document.

openInputStream

protected InputStream openInputStream(URLConnection con)
                               throws IOException

Throws:

IOException

parseDocument

protected DOM4JUserAgent.AgentXHTMLDocumentFactory.AgentXHTMLDocument parseDocument(Reader re)
                                                                             throws DocumentException,
IOException

Throws:

DocumentException

IOException

getXHTMLDocumentFactory

public XHTMLDocumentFactory getXHTMLDocumentFactory()