A B C D E F G H I J L M N O P R S T V W X

A

absUrl(String) - Method in class org.jsoup.nodes.Node

Get an absolute URL from a URL attribute that may be relative (i.e.

add(Element) - Method in class org.jsoup.select.Elements

add(int, Element) - Method in class org.jsoup.select.Elements

addAll(Attributes) - Method in class org.jsoup.nodes.Attributes

Add all the attributes from the incoming set to this set.

addAll(Collection<? extends Element>) - Method in class org.jsoup.select.Elements

addAll(int, Collection<? extends Element>) - Method in class org.jsoup.select.Elements

addAttributes(String, String...) - Method in class org.jsoup.safety.Whitelist

Add a list of allowed attributes to a tag.

addChild(Node) - Method in class org.jsoup.nodes.Node

addEnforcedAttribute(String, String, String) - Method in class org.jsoup.safety.Whitelist

Add an enforced attribute to a tag.

addFirst(Character) - Method in class org.jsoup.parser.TokenQueue

Add a character to the start of the queue (will be the next character retrieved).

addFirst(String) - Method in class org.jsoup.parser.TokenQueue

Add a string to the start of the queue.

addProtocols(String, String, String...) - Method in class org.jsoup.safety.Whitelist

Add allowed URL protocols for an element's URL attribute.

addTags(String...) - Method in class org.jsoup.safety.Whitelist

Add a list of allowed elements to a whitelist.

append(String) - Method in class org.jsoup.nodes.Element

Add inner HTML to this element.

appendChild(Node) - Method in class org.jsoup.nodes.Element

Add a node to the last child of this element.

appendElement(String) - Method in class org.jsoup.nodes.Element

Create a new element by tag name, and add it as the last child.

appendText(String) - Method in class org.jsoup.nodes.Element

Create and append a new TextNode to this element.

asList() - Method in class org.jsoup.nodes.Attributes

Get the attributes as a List, for iteration.

attr(String, String) - Method in class org.jsoup.nodes.Element

Set an attribute value on this element.

attr(String) - Method in class org.jsoup.nodes.Node

Get an attribute's value by its key.

attr(String, String) - Method in class org.jsoup.nodes.Node

Set an attribute (key=value).

attr(String) - Method in class org.jsoup.select.Elements

Get the attribute value of the first matched element.

attr(String, String) - Method in class org.jsoup.select.Elements

Set an attribute on all matched elements.

Attribute - Class in org.jsoup.nodes

A single key + value attribute.

Attribute(String, String) - Constructor for class org.jsoup.nodes.Attribute

Create a new attribute from unencoded (raw) key and value.

Attributes - Class in org.jsoup.nodes

The attributes of an Element.

Attributes() - Constructor for class org.jsoup.nodes.Attributes

attributes() - Method in class org.jsoup.nodes.Node

Get all of the element's attributes.

B

baseUri() - Method in class org.jsoup.nodes.Node

Get the base URI of this node.

basic() - Static method in class org.jsoup.safety.Whitelist

This whitelist allows a fuller range of text nodes: a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, strike, strong, sub, sup, u, ul, and appropriate attributes.

basicWithImages() - Static method in class org.jsoup.safety.Whitelist

This whitelist allows the same text tags as Whitelist.basic(), and also allows img tags, with appropriate attributes, with src pointing to http or https.

body() - Method in class org.jsoup.nodes.Document

Accessor to the document's body element.

C

canContainBlock() - Method in class org.jsoup.parser.Tag

Gets if this tag can contain block tags.

child(int) - Method in class org.jsoup.nodes.Element

Get a child element of this element, by its 0-based index number.

childNode(int) - Method in class org.jsoup.nodes.Node

Get a child node by index

childNodes() - Method in class org.jsoup.nodes.Node

Get this node's children.

children() - Method in class org.jsoup.nodes.Element

Get this element's child elements.

chompTo(String) - Method in class org.jsoup.parser.TokenQueue

Pulls a string off the queue (like consumeTo), and then pulls off the matched string (but does not return it).

className() - Method in class org.jsoup.nodes.Element

Gets the literal value of this element's "class" attribute, which may include multiple class names, space separated.

classNames() - Method in class org.jsoup.nodes.Element

Get all of the element's class names.

clean(String, String, Whitelist) - Static method in class org.jsoup.Jsoup

Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.

clean(String, Whitelist) - Static method in class org.jsoup.Jsoup

Get safe HTML from untrusted input HTML, by parsing input HTML and filtering it through a white-list of permitted tags and attributes.

clean(Document) - Method in class org.jsoup.safety.Cleaner

Creates a new, clean document, from the original dirty document, containing only elements allowed by the whitelist.

Cleaner - Class in org.jsoup.safety

The whitelist based HTML cleaner.

Cleaner(Whitelist) - Constructor for class org.jsoup.safety.Cleaner

Create a new cleaner, that sanitizes documents using the supplied whitelist.

clear() - Method in class org.jsoup.select.Elements

collect(Evaluator, Element) - Static method in class org.jsoup.select.Collector

Build a list of elements, by visiting root and every descendant of root, and testing it against the evaluator.

Collector - Class in org.jsoup.select

Collects a list of elements that match the supplied criteria.

Collector() - Constructor for class org.jsoup.select.Collector

Comment - Class in org.jsoup.nodes

A comment node.

Comment(String, String) - Constructor for class org.jsoup.nodes.Comment

Create a new comment node.

consume() - Method in class org.jsoup.parser.TokenQueue

Consume one character off queue.

consume(String) - Method in class org.jsoup.parser.TokenQueue

Consumes the supplied sequence of the queue.

consumeAttributeKey() - Method in class org.jsoup.parser.TokenQueue

Consume an attribute key off the queue (letter, digit, -, _, :")

consumeClassName() - Method in class org.jsoup.parser.TokenQueue

Consume a HTML class name off the queue (letter, digit, -, _)

consumeTo(String) - Method in class org.jsoup.parser.TokenQueue

Pulls a string off the queue, up to but exclusive of the match sequence, or to the queue running out.

consumeToAny(String...) - Method in class org.jsoup.parser.TokenQueue

Consumes to the first sequence provided, or to the end of the queue.

consumeWhitespace() - Method in class org.jsoup.parser.TokenQueue

Pulls the next run of whitespace characters of the queue.

consumeWord() - Method in class org.jsoup.parser.TokenQueue

Retrieves the next run of word type (letter or digit) off the queue.

contains(Object) - Method in class org.jsoup.select.Elements

containsAll(Collection<?>) - Method in class org.jsoup.select.Elements

createElement(String) - Method in class org.jsoup.nodes.Document

Create a new Element, with this document's base uri.

createFromEncoded(String, String) - Static method in class org.jsoup.nodes.Attribute

Create a new Attribute from an unencoded key and a HMTL attribute encoded value.

createFromEncoded(String, String) - Static method in class org.jsoup.nodes.DataNode

Create a new DataNode from HTML encoded data.

createFromEncoded(String, String) - Static method in class org.jsoup.nodes.TextNode

Create a new TextNode from HTML encoded (aka escaped) data.

createShell(String) - Static method in class org.jsoup.nodes.Document

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

D

data() - Method in class org.jsoup.nodes.Element

Get the combined data of this element.

DataNode - Class in org.jsoup.nodes

A data node, for contents of style, script tags etc, where contents should not show in text().

DataNode(String, String) - Constructor for class org.jsoup.nodes.DataNode

Create a new DataNode.

Document - Class in org.jsoup.nodes

A HTML Document.

Document(String) - Constructor for class org.jsoup.nodes.Document

Create a new, empty Document.

E

Element - Class in org.jsoup.nodes

A HTML element consists of a tag name, attributes, and child nodes (including text nodes and other elements).

Element(Tag, String, Attributes) - Constructor for class org.jsoup.nodes.Element

Create a new, standalone Element.

Element(Tag, String) - Constructor for class org.jsoup.nodes.Element

Create a new Element from a tag and a base URI.

Elements - Class in org.jsoup.select

A list of Elements, with methods that act on every element in the list

Elements() - Constructor for class org.jsoup.select.Elements

Elements(Collection<Element>) - Constructor for class org.jsoup.select.Elements

Elements(List<Element>) - Constructor for class org.jsoup.select.Elements

Elements(Element...) - Constructor for class org.jsoup.select.Elements

elementSiblingIndex() - Method in class org.jsoup.nodes.Element

Get the list index of this element in its element sibling list.

empty() - Method in class org.jsoup.nodes.Element

Remove all of the element's child nodes.

eq(int) - Method in class org.jsoup.select.Elements

Reduce the matched elements to one element

equals(Object) - Method in class org.jsoup.nodes.Attribute

equals(Object) - Method in class org.jsoup.nodes.Attributes

equals(Object) - Method in class org.jsoup.nodes.Element

equals(Object) - Method in class org.jsoup.nodes.Node

equals(Object) - Method in class org.jsoup.parser.Tag

equals(Object) - Method in class org.jsoup.select.Elements

Evaluator - Class in org.jsoup.nodes

Evaluates that an element matches the selector.

F

first() - Method in class org.jsoup.select.Elements

Get the first matched element.

firstElementSibling() - Method in class org.jsoup.nodes.Element

Gets the first element sibling of this element.

G

get(String) - Method in class org.jsoup.nodes.Attributes

Get an attribute value by key.

get(int) - Method in class org.jsoup.select.Elements

getAllElements() - Method in class org.jsoup.nodes.Element

Find all elements under this element (including self, and children of children).

getData() - Method in class org.jsoup.nodes.Comment

Get the contents of the comment.

getElementById(String) - Method in class org.jsoup.nodes.Element

Find an element by ID, including or under this element.

getElementsByAttribute(String) - Method in class org.jsoup.nodes.Element

Find elements that have a named attribute set.

getElementsByAttributeValue(String, String) - Method in class org.jsoup.nodes.Element

Find elements that have an attribute with the specific value.

getElementsByAttributeValueContaining(String, String) - Method in class org.jsoup.nodes.Element

Find elements that have attributes whose value contains the match string.

getElementsByAttributeValueEnding(String, String) - Method in class org.jsoup.nodes.Element

Find elements that have attributes that end with the value suffix.

getElementsByAttributeValueNot(String, String) - Method in class org.jsoup.nodes.Element

Find elements that either do not have this attribute, or have it with a different value.

getElementsByAttributeValueStarting(String, String) - Method in class org.jsoup.nodes.Element

Find elements that have attributes that start with the value prefix.

getElementsByClass(String) - Method in class org.jsoup.nodes.Element

Find elements that have this class, including or under this element.

getElementsByTag(String) - Method in class org.jsoup.nodes.Element

Finds elements, including and recursively under this element, with the specified tag name.

getKey() - Method in class org.jsoup.nodes.Attribute

Get the attribute key.

getName() - Method in class org.jsoup.parser.Tag

getValue() - Method in class org.jsoup.nodes.Attribute

Get the attribute value.

getWholeData() - Method in class org.jsoup.nodes.DataNode

Get the data contents of this node.

getWholeDeclaration() - Method in class org.jsoup.nodes.XmlDeclaration

Get the unencoded XML declaration.

getWholeText() - Method in class org.jsoup.nodes.TextNode

Get the (unencoded) text of this text node, including any newlines and spaces present in the original.

H

hasAttr(String) - Method in class org.jsoup.nodes.Node

Test if this element has an attribute.

hasAttr(String) - Method in class org.jsoup.select.Elements

Checks if the first matched value has this attribute set.

hasClass(String) - Method in class org.jsoup.nodes.Element

Tests if this element has a class.

hashCode() - Method in class org.jsoup.nodes.Attribute

hashCode() - Method in class org.jsoup.nodes.Attributes

hashCode() - Method in class org.jsoup.nodes.Element

hashCode() - Method in class org.jsoup.nodes.Node

hashCode() - Method in class org.jsoup.parser.Tag

hashCode() - Method in class org.jsoup.select.Elements

hasKey(String) - Method in class org.jsoup.nodes.Attributes

Tests if these attributes contain an attribute with this key.

head() - Method in class org.jsoup.nodes.Document

Accessor to the document's head element.

html() - Method in class org.jsoup.nodes.Attribute

Get the HTML representation of this attribute; e.g.

html() - Method in class org.jsoup.nodes.Attributes

Get the HTML representation of these attributes.

html() - Method in class org.jsoup.nodes.Element

Retrieves the element's inner HTML.

html(String) - Method in class org.jsoup.nodes.Element

Set this element's inner HTML.

I

id() - Method in class org.jsoup.nodes.Element

Get the id attribute of this element.

indexInList(N, List<N>) - Static method in class org.jsoup.nodes.Node

indexOf(Object) - Method in class org.jsoup.select.Elements

is(String) - Method in class org.jsoup.select.Elements

Test if any of the matched elements match the supplied query.

isBlock() - Method in class org.jsoup.nodes.Element

Test if this element is a block-level element.

isBlock() - Method in class org.jsoup.parser.Tag

Gets if this is a block tag.

isData() - Method in class org.jsoup.parser.Tag

Gets if this tag is a data only tag.

isEmpty() - Method in class org.jsoup.parser.Tag

Get if this is an empty tag

isEmpty() - Method in class org.jsoup.parser.TokenQueue

Is the queue empty?

isEmpty() - Method in class org.jsoup.select.Elements

isInline() - Method in class org.jsoup.parser.Tag

Gets if this tag is an inline tag.

iterator() - Method in class org.jsoup.nodes.Attributes

iterator() - Method in class org.jsoup.select.Elements

J

Jsoup - Class in org.jsoup

The core public access point to the jsoup functionality.

L

last() - Method in class org.jsoup.select.Elements

Get the last matched element.

lastElementSibling() - Method in class org.jsoup.nodes.Element

Gets the last element sibling of this element

lastIndexOf(Object) - Method in class org.jsoup.select.Elements

listIterator() - Method in class org.jsoup.select.Elements

listIterator(int) - Method in class org.jsoup.select.Elements

ListLinks - Class in org.jsoup.examples

Example program to list links from a URL.

ListLinks() - Constructor for class org.jsoup.examples.ListLinks

M

main(String[]) - Static method in class org.jsoup.examples.ListLinks

matchChomp(String) - Method in class org.jsoup.parser.TokenQueue

Tests if the queue matches the sequence (as with match), and if they do, removes the matched string from the queue.

matches(Element) - Method in class org.jsoup.nodes.Evaluator

Test if the element meets the evaluator's requirements.

matches(String) - Method in class org.jsoup.parser.TokenQueue

Tests if the next characters on the queue match the sequence.

matchesAny(String...) - Method in class org.jsoup.parser.TokenQueue

Tests if the next characters match any of the sequences.

matchesWhitespace() - Method in class org.jsoup.parser.TokenQueue

Tests if queue starts with a whitespace character.

matchesWord() - Method in class org.jsoup.parser.TokenQueue

Test if the queue matches a word character (letter or digit).

N

nextElementSibling() - Method in class org.jsoup.nodes.Element

Gets the next sibling element of this element.

nextSibling() - Method in class org.jsoup.nodes.Node

Get this node's next sibling.

Node - Class in org.jsoup.nodes

The base, abstract Node model.

Node(String, Attributes) - Constructor for class org.jsoup.nodes.Node

Create a new Node.

Node(String) - Constructor for class org.jsoup.nodes.Node

nodeName() - Method in class org.jsoup.nodes.Comment

nodeName() - Method in class org.jsoup.nodes.DataNode

nodeName() - Method in class org.jsoup.nodes.Document

nodeName() - Method in class org.jsoup.nodes.Element

nodeName() - Method in class org.jsoup.nodes.Node

Get the node name of this node.

nodeName() - Method in class org.jsoup.nodes.TextNode

nodeName() - Method in class org.jsoup.nodes.XmlDeclaration

none() - Static method in class org.jsoup.safety.Whitelist

This whitelist allows only text nodes: all HTML will be stripped.

O

org.jsoup - package org.jsoup

Contains the main Jsoup class, which provides convenient static access to the jsoup functionality.

org.jsoup.examples - package org.jsoup.examples

Contains example programs and use of jsoup.

org.jsoup.nodes - package org.jsoup.nodes

HTML document structure nodes.

org.jsoup.parser - package org.jsoup.parser

Contains the HTML parser, tag specifications, and HTML tokeniser.

org.jsoup.safety - package org.jsoup.safety

Contains the jsoup HMTL cleaner, and whitelist definitions.

org.jsoup.select - package org.jsoup.select

Packages to support the CSS-style element selector.

outerHtml() - Method in class org.jsoup.nodes.Document

outerHtml() - Method in class org.jsoup.nodes.Node

Get the outer HTML of this node.

P

parent() - Method in class org.jsoup.nodes.Element

parent() - Method in class org.jsoup.nodes.Node

Gets this node's parent node.

parse(String, String) - Static method in class org.jsoup.Jsoup

Parse HTML into a Document.

parse(String) - Static method in class org.jsoup.Jsoup

Parse HTML into a Document.

parse(URL, int) - Static method in class org.jsoup.Jsoup

Fetch a URL, and parse it as HTML.

parse(File, String, String) - Static method in class org.jsoup.Jsoup

Parse the contents of a file as HTML.

parse(File, String) - Static method in class org.jsoup.Jsoup

Parse the contents of a file as HTML.

parse(String, String) - Static method in class org.jsoup.parser.Parser

Parse HTML into a Document.

parseBodyFragment(String, String) - Static method in class org.jsoup.Jsoup

Parse a fragment of HTML, with the assumption that it forms the body of the HTML.

parseBodyFragment(String) - Static method in class org.jsoup.Jsoup

Parse a fragment of HTML, with the assumption that it forms the body of the HTML.

parseBodyFragment(String, String) - Static method in class org.jsoup.parser.Parser

Parse a fragment of HTML into the body of a Document.

Parser - Class in org.jsoup.parser

Parses HTML into a Document.

peek() - Method in class org.jsoup.parser.TokenQueue

Retrieves but does not remove the first characater from the queue.

prepend(String) - Method in class org.jsoup.nodes.Element

Add inner HTML to this element.

prependChild(Node) - Method in class org.jsoup.nodes.Element

Add a node to the start of this element's children.

prependElement(String) - Method in class org.jsoup.nodes.Element

Create a new element by tag name, and add it as the first child.

prependText(String) - Method in class org.jsoup.nodes.Element

Create and prepend a new TextNode to this element.

preserveWhitespace() - Method in class org.jsoup.parser.Tag

Get if this tag should preserve whitespace within child text nodes.

previousElementSibling() - Method in class org.jsoup.nodes.Element

Gets the previous element sibling of this element.

previousSibling() - Method in class org.jsoup.nodes.Node

Get this node's previous sibling.

put(String, String) - Method in class org.jsoup.nodes.Attributes

Set a new attribute, or replace an existing one by key.

put(Attribute) - Method in class org.jsoup.nodes.Attributes

Set a new attribute, or replace an existing one by key.

R

relaxed() - Static method in class org.jsoup.safety.Whitelist

This whitelist allows a full range of text and structural body HTML: a, b, blockquote, br, caption, cite, code, col, colgroup, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, i, img, li, ol, p, pre, q, small, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, u, ul

Links do not have an enforced rel=nofollow attribute, but you can add that if desired.

remainder() - Method in class org.jsoup.parser.TokenQueue

Consume and return whatever is left on the queue.

remove(String) - Method in class org.jsoup.nodes.Attributes

Remove an attribute by key.

remove(Object) - Method in class org.jsoup.select.Elements

remove(int) - Method in class org.jsoup.select.Elements

removeAll(Collection<?>) - Method in class org.jsoup.select.Elements

removeAttr(String) - Method in class org.jsoup.nodes.Node

Remove an attribute from this element.

removeAttr(String) - Method in class org.jsoup.select.Elements

Remove an attribute from every matched element.

removeChild(Node) - Method in class org.jsoup.nodes.Node

replaceChild(Node, Node) - Method in class org.jsoup.nodes.Node

retainAll(Collection<?>) - Method in class org.jsoup.select.Elements

S

select(String) - Method in class org.jsoup.nodes.Element

Find elements that match the selector query, with this element as the starting context.

select(String) - Method in class org.jsoup.select.Elements

Find matching elements within this element list.

select(String, Element) - Static method in class org.jsoup.select.Selector

Find elements matching selector.

select(String, Iterable<Element>) - Static method in class org.jsoup.select.Selector

Find elements matching selector.

Selector - Class in org.jsoup.select

CSS-like element selector, that finds elements matching a query.

Selector.SelectorParseException - Exception in org.jsoup.select

Selector.SelectorParseException(String) - Constructor for exception org.jsoup.select.Selector.SelectorParseException

set(int, Element) - Method in class org.jsoup.select.Elements

setBaseUri(String) - Method in class org.jsoup.nodes.Node

Update the base URI of this node.

setKey(String) - Method in class org.jsoup.nodes.Attribute

Set the attribute key.

setParentNode(Node) - Method in class org.jsoup.nodes.Node

setValue(String) - Method in class org.jsoup.nodes.Attribute

Set the attribute value.

siblingElements() - Method in class org.jsoup.nodes.Element

Get sibling elements.

siblingNodes() - Method in class org.jsoup.nodes.Node

Retrieves this node's sibling nodes.

simpleText() - Static method in class org.jsoup.safety.Whitelist

This whitelist allows only simple text formatting: b, em, i, strong, u.

size() - Method in class org.jsoup.nodes.Attributes

Get the number of attributes in this set.

size() - Method in class org.jsoup.select.Elements

subList(int, int) - Method in class org.jsoup.select.Elements

T

tag() - Method in class org.jsoup.nodes.Element

Get the Tag for this element.

Tag - Class in org.jsoup.parser

HTML Tag specifications.

tagName() - Method in class org.jsoup.nodes.Element

Get the name of the tag for this element.

text(String) - Method in class org.jsoup.nodes.Document

Set the text of the body of this document.

text() - Method in class org.jsoup.nodes.Element

Gets the combined text of this element and all its children.

text(String) - Method in class org.jsoup.nodes.Element

Set the text of this element.

text() - Method in class org.jsoup.select.Elements

Get the combined text of all the matched elements.

TextNode - Class in org.jsoup.nodes

A text node.

TextNode(String, String) - Constructor for class org.jsoup.nodes.TextNode

Create a new TextNode representing the supplied (unencoded) text).

title() - Method in class org.jsoup.nodes.Document

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

title(String) - Method in class org.jsoup.nodes.Document

Set the document's title element.

toArray() - Method in class org.jsoup.select.Elements

toArray(T[]) - Method in class org.jsoup.select.Elements

TokenQueue - Class in org.jsoup.parser

A character queue with parsing helpers.

TokenQueue(String) - Constructor for class org.jsoup.parser.TokenQueue

Create a new TokenQueue.

toString() - Method in class org.jsoup.nodes.Attribute

Get the string representation of this attribute, implemented as Attribute.html().

toString() - Method in class org.jsoup.nodes.Attributes

toString() - Method in class org.jsoup.nodes.Comment

toString() - Method in class org.jsoup.nodes.DataNode

toString() - Method in class org.jsoup.nodes.Element

toString() - Method in class org.jsoup.nodes.Node

toString() - Method in class org.jsoup.nodes.TextNode

toString() - Method in class org.jsoup.nodes.XmlDeclaration

toString() - Method in class org.jsoup.parser.Tag

toString() - Method in class org.jsoup.parser.TokenQueue

V

valueOf(String) - Static method in class org.jsoup.parser.Tag

Get a Tag by name.

W

Whitelist - Class in org.jsoup.safety

Whitelists define what HTML (elements and attributes) to allow through the cleaner.

Whitelist() - Constructor for class org.jsoup.safety.Whitelist

Create a new, empty whitelist.

wrap(String) - Method in class org.jsoup.nodes.Element

Wrap the supplied HTML around this element.

wrap(String) - Method in class org.jsoup.select.Elements

Wrap the supplied HTML around each matched elements.

X

XmlDeclaration - Class in org.jsoup.nodes

An XML Declaration.

XmlDeclaration(String, String, boolean) - Constructor for class org.jsoup.nodes.XmlDeclaration

Create a new XML declaration

A B C D E F G H I J L M N O P R S T V W X