Package rife.test

Class ParsedHtml

java.lang.Object

rife.test.ParsedHtml

public class ParsedHtml
extends Object

Retrieves the text content of a MockResponse and parses it as HTML.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
Document	getDocument()	Retrieves the document that corresponds to the parsed HTML.
static String	getElementAttribute(Element element, String attributeName)	Retrieves the value of the attribute of an JSoup element.
List<MockForm>	getForms()	Retrieves the list of all the forms in the HTML document.
MockForm	getFormWithId(String id)	Retrieves the first form in the HTML document with a particular id attribute.
MockForm	getFormWithName(String name)	Retrieves the first form in the HTML document with a particular name attribute.
List<MockLink>	getLinks()	Retrieves the list of all the links in the HTML document.
MockLink	getLinkWithId(String id)	Retrieves the first link in the HTML document with a particular id attribute.
MockLink	getLinkWithImageAlt(String alt)	Retrieves the first link in the HTML document that surrounds an img tag with a certain alt attribute.
MockLink	getLinkWithImageName(String name)	Retrieves the first link in the HTML document that surrounds an img tag with a certain name attribute.
MockLink	getLinkWithName(String name)	Retrieves the first link in the HTML document with a particular name attribute.
MockLink	getLinkWithText(String text)	Retrieves the first link in the HTML document that surrounds a particular text.
String	getTitle()	Retrieves the text of the title tag.
static ParsedHtml	parse(MockResponse response)	Parses the text content of a MockResponse object as HTML and returns the result as an instance of ParsedHtml.

Methods inherited from class java.lang.Object

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

Method Details

parse

public static ParsedHtml parse(MockResponse response)

Parses the text content of a MockResponse object as HTML and returns the result as an instance of ParsedHtml.

Parameters:

response - the response whose text content will be parsed

Returns:

the resulting instance of ParsedHtml

Since:

1.0

getDocument

public Document getDocument()

Retrieves the document that corresponds to the parsed HTML.

Returns:

the parsed document

Since:

1.0

getTitle

public String getTitle()

Retrieves the text of the title tag.

Returns:

the title

Since:

1.0

getForms

public List<MockForm> getForms()

Retrieves the list of all the forms in the HTML document.

Returns:

a list with MockForm instances

Since:

1.0

See Also:

• getFormWithName(java.lang.String)
• getFormWithId(java.lang.String)

getFormWithName

public MockForm getFormWithName(String name)

Retrieves the first form in the HTML document with a particular name attribute.

Parameters:

name - the content of the name attribute

Returns:

the first MockForm whose name attribute matches; or

null if no such form could be found

Since:

1.0

See Also:

• getForms()
• getFormWithId(java.lang.String)

getFormWithId

public MockForm getFormWithId(String id)

Retrieves the first form in the HTML document with a particular id attribute.

Parameters:

id - the content of the id attribute

Returns:

the first MockForm whose id attribute matches; or

null if no such form could be found

Since:

1.0

See Also:

• getForms()
• getFormWithName(java.lang.String)

getLinks

public List<MockLink> getLinks()

Retrieves the list of all the links in the HTML document.

Returns:

a list with MockLink instances

Since:

1.0

See Also:

• getLinkWithName(java.lang.String)
• getLinkWithId(java.lang.String)
• getLinkWithText(java.lang.String)
• getLinkWithImageAlt(java.lang.String)
• getLinkWithImageName(java.lang.String)

getLinkWithName

public MockLink getLinkWithName(String name)

Retrieves the first link in the HTML document with a particular name attribute.

Parameters:

name - the content of the name attribute

Returns:

the first MockLink whose name attribute matches; or

null if no such link could be found

Since:

1.0

See Also:

• getLinks()
• getLinkWithId(java.lang.String)
• getLinkWithText(java.lang.String)
• getLinkWithImageAlt(java.lang.String)
• getLinkWithImageName(java.lang.String)

getLinkWithId

public MockLink getLinkWithId(String id)

Retrieves the first link in the HTML document with a particular id attribute.

Parameters:

id - the content of the id attribute

Returns:

the first MockLink whose id attribute matches; or

null if no such link could be found

Since:

1.0

See Also:

• getLinks()
• getLinkWithName(java.lang.String)
• getLinkWithText(java.lang.String)
• getLinkWithImageAlt(java.lang.String)
• getLinkWithImageName(java.lang.String)

getLinkWithText

public MockLink getLinkWithText(String text)

Retrieves the first link in the HTML document that surrounds a particular text.

Parameters:

text - the surrounded text

Returns:

the first MockLink whose surrounded text matches; or

null if no such link could be found

Since:

1.0

See Also:

• getLinks()
• getLinkWithName(java.lang.String)
• getLinkWithId(java.lang.String)
• getLinkWithText(java.lang.String)
• getLinkWithImageName(java.lang.String)

getLinkWithImageAlt

public MockLink getLinkWithImageAlt(String alt)

Retrieves the first link in the HTML document that surrounds an img tag with a certain alt attribute.

Parameters:

alt - the content of the alt attribute

Returns:

the first MockLink that has an img tag whose alt attribute matches; or

null if no such link could be found

Since:

1.0

See Also:

• getLinks()
• getLinkWithName(java.lang.String)
• getLinkWithId(java.lang.String)
• getLinkWithText(java.lang.String)
• getLinkWithImageName(java.lang.String)

getLinkWithImageName

public MockLink getLinkWithImageName(String name)

Retrieves the first link in the HTML document that surrounds an img tag with a certain name attribute.

Parameters:

name - the content of the name attribute

Returns:

the first MockLink that has an img tag whose name attribute matches; or

null if no such link could be found

Since:

1.0

See Also:

• getLinks()
• getLinkWithName(java.lang.String)
• getLinkWithId(java.lang.String)
• getLinkWithText(java.lang.String)
• getLinkWithImageAlt(java.lang.String)

getElementAttribute

public static String getElementAttribute(Element element,
 String attributeName)

Retrieves the value of the attribute of an JSoup element.

Parameters:

element - the element where the attribute should be obtained from

attributeName - the name of the attribute

Returns:

the value of the attribute; or

null if no attribute could be found

Since:

1.0