org.jsoup.nodes
Class Document

java.lang.Object
  org.jsoup.nodes.Node
      org.jsoup.nodes.Element
          org.jsoup.nodes.Document

public class Document
extends Element

A HTML Document.

Author:

Jonathan Hedley, jonathan@hedley.net

Nested Class Summary

class

Document.OutputSettings A Document's output settings control the form of the text() and html() methods.

Constructor Summary

Document(String baseUri)
Create a new, empty Document.

Method Summary

Element	body() Accessor to the document's body element.
Element	createElement(String tagName) Create a new Element, with this document's base uri.
static Document	createShell(String baseUri) Create a valid, empty shell of a document, suitable for adding more elements to.
Element	head() Accessor to the document's head element.
String	nodeName() Get the node name of this node.
Document	normalise() Normalise the document.
String	outerHtml() Get the outer HTML of this node.
Document.OutputSettings	outputSettings() Get the document's current output settings.
Element	text(String text) Set the text of the body of this document.
String	title() Get the string contents of the document's title element.
void	title(String title) Set the document's title element.

Methods inherited from class org.jsoup.nodes.Element

addClass, after, append, appendChild, appendElement, appendText, attr, before, child, children, className, classNames, classNames, data, dataset, elementSiblingIndex, empty, equals, firstElementSibling, getAllElements, getElementById, getElementsByAttribute, getElementsByAttributeStarting, getElementsByAttributeValue, getElementsByAttributeValueContaining, getElementsByAttributeValueEnding, getElementsByAttributeValueMatching, getElementsByAttributeValueMatching, getElementsByAttributeValueNot, getElementsByAttributeValueStarting, getElementsByClass, getElementsByIndexEquals, getElementsByIndexGreaterThan, getElementsByIndexLessThan, getElementsByTag, getElementsContainingOwnText, getElementsContainingText, getElementsMatchingOwnText, getElementsMatchingOwnText, getElementsMatchingText, getElementsMatchingText, hasClass, hashCode, hasText, html, html, id, isBlock, lastElementSibling, nextElementSibling, ownText, parent, parents, prepend, prependChild, prependElement, prependText, previousElementSibling, removeClass, select, siblingElements, tag, tagName, text, toggleClass, toString, val, val, wrap

Methods inherited from class org.jsoup.nodes.Node

absUrl, addChildren, addChildren, attr, attributes, baseUri, childNode, childNodes, childNodesAsArray, hasAttr, indent, nextSibling, outerHtml, ownerDocument, previousSibling, remove, removeAttr, removeChild, replaceChild, replaceWith, setBaseUri, setParentNode, setSiblingIndex, siblingIndex, siblingNodes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document(String baseUri)

Create a new, empty Document.

Parameters:

baseUri - base URI of document

See Also:

Jsoup.parse(java.lang.String, java.lang.String), createShell(java.lang.String)

Method Detail

createShell

public static Document createShell(String baseUri)

Create a valid, empty shell of a document, suitable for adding more elements to.

Parameters:

baseUri - baseUri of document

Returns:

document with html, head, and body elements.

head

public Element head()

Accessor to the document's head element.

Returns:

head

body

public Element body()

Accessor to the document's body element.

Returns:

body

title

public String title()

Get the string contents of the document's title element.

Returns:

Trimed title, or empty string if none set.

title

public void title(String title)

Set the document's title element. Updates the existing element, or adds title to head if not present

Parameters:

title - string to set as title

createElement

public Element createElement(String tagName)

Create a new Element, with this document's base uri. Does not make the new element a child of this document.

Parameters:

tagName - element tag name (e.g. a)

Returns:

new element

normalise

public Document normalise()

Normalise the document. This happens after the parse phase so generally does not need to be called. Moves any text content that is not in the body element into the body.

Returns:

this document after normalisation

outerHtml

public String outerHtml()

Description copied from class: Node

Get the outer HTML of this node.

Overrides:

outerHtml in class Node

Returns:

HTML

text

public Element text(String text)

Set the text of the body of this document. Any existing nodes within the body will be cleared.

Overrides:

text in class Element

Parameters:

text - unencoded text

Returns:

this document

nodeName

public String nodeName()

Description copied from class: Node

Get the node name of this node. Use for debugging purposes and not logic switching (for that, use instanceof).

Overrides:

nodeName in class Element

Returns:

node name

outputSettings

public Document.OutputSettings outputSettings()

Get the document's current output settings.

Returns:

the document's current output settings.