Module io.sf.carte.css4j

Package io.sf.carte.doc.agent

Interface UserAgent

All Known Implementing Classes:

AbstractUserAgent, DefaultUserAgent, DOM4JUserAgent, DOMCSSStyleSheetFactory.WrapperUserAgent

public interface UserAgent

Very basic user agent abstraction.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UserAgent.AgentControl	User agent configuration and control.

Method Summary

Modifier and Type	Method	Description
UserAgent.AgentControl	getAgentControl()	Get the control object for this user agent.
boolean	isVisitedURL(URL url)	Has the provided url been visited by this user agent.
CSSDocument	readURL(URL url)	Reads and parses a markup document located at the given URL.
void	setEntityResolver(EntityResolver resolver)	Sets the entity resolver to be used when parsing documents.

Method Details

readURL

CSSDocument readURL(URL url)
             throws IOException,
DocumentException

Reads and parses a markup document located at the given URL.

Parameters:

url - the URL that points to the document.

Returns:

the CSSDocument.

Throws:

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

DocumentException - if there is a problem parsing the document.

isVisitedURL

boolean isVisitedURL(URL url)

Has the provided url been visited by this user agent.

Parameters:

url - the URL to test.

Returns:

true if the URL was visited by this agent, false if not visited or this agent does not support history.

setEntityResolver

void setEntityResolver(EntityResolver resolver)

Sets the entity resolver to be used when parsing documents.

Parameters:

resolver - the entity resolver.

getAgentControl

UserAgent.AgentControl getAgentControl()

Get the control object for this user agent.

Returns:

the control object for this user agent, or null if this agent has no control.