Package | Description |
---|---|
org.jsoup.examples |
Contains example programs and use of jsoup.
|
org.jsoup.helper |
Package containing classes supporting the core jsoup code.
|
org.jsoup.nodes |
HTML document structure nodes.
|
org.jsoup.parser |
Contains the HTML parser, tag specifications, and HTML tokeniser.
|
org.jsoup.safety |
Contains the jsoup HTML cleaner, and safelist definitions.
|
org.jsoup.select |
Packages to support the CSS-style element selector.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
HtmlToPlainText.getPlainText(Element element)
Format an Element to plain-text
|
Modifier and Type | Field and Description |
---|---|
private Element |
W3CDom.W3CBuilder.contextElement |
Modifier and Type | Method and Description |
---|---|
void |
W3CDom.convert(Element in,
org.w3c.dom.Document out)
Converts a jsoup element into the provided W3C Document.
|
org.w3c.dom.Document |
W3CDom.fromJsoup(Element in)
Convert a jsoup DOM to a W3C Document.
|
private java.lang.String |
W3CDom.W3CBuilder.updateNamespaces(Element el)
Finds any namespaces defined in this element.
|
Modifier and Type | Class and Description |
---|---|
class |
Document
A HTML Document.
|
class |
FormElement
A HTML Form Element provides ready access to the form fields/controls that are associated with it.
|
class |
PseudoTextElement
|
Modifier and Type | Field and Description |
---|---|
private Element |
Element.NodeList.owner |
Modifier and Type | Field and Description |
---|---|
private static java.util.List<Element> |
Element.EmptyChildren |
private java.lang.ref.WeakReference<java.util.List<Element>> |
Element.shadowChildrenRef |
Modifier and Type | Method and Description |
---|---|
private static <E extends Element> |
Element.indexInList(Element search,
java.util.List<E> elements) |
Modifier and Type | Method and Description |
---|---|
Element |
Element.addClass(java.lang.String className)
Add a class name to this element's
class attribute. |
Element |
Element.after(Node node)
Insert the specified node into the DOM after this node (as a following sibling).
|
Element |
Element.after(java.lang.String html)
Insert the specified HTML into the DOM after this element (as a following sibling).
|
Element |
Element.append(java.lang.String html)
Add inner HTML to this element.
|
Element |
Element.appendChild(Node child)
Insert a node to the end of this Element's children.
|
Element |
Element.appendChildren(java.util.Collection<? extends Node> children)
Insert the given nodes to the end of this Element's children.
|
Element |
Element.appendElement(java.lang.String tagName)
Create a new element by tag name, and add it as the last child.
|
Element |
Element.appendText(java.lang.String text)
Create and append a new TextNode to this element.
|
Element |
Element.appendTo(Element parent)
Add this element to the supplied parent element, as its next child.
|
Element |
Element.attr(java.lang.String attributeKey,
boolean attributeValue)
Set a boolean attribute value on this element.
|
Element |
Element.attr(java.lang.String attributeKey,
java.lang.String attributeValue)
Set an attribute value on this element.
|
Element |
Element.before(Node node)
Insert the specified node into the DOM before this node (as a preceding sibling).
|
Element |
Element.before(java.lang.String html)
Insert the specified HTML into the DOM before this element (as a preceding sibling).
|
Element |
Document.body()
Get this document's
<body> or <frameset> element. |
Element |
Element.child(int index)
Get a child element of this element, by its 0-based index number.
|
Element |
Element.classNames(java.util.Set<java.lang.String> classNames)
Set the element's
class attribute to the supplied class names. |
Element |
Element.clearAttributes() |
Element |
Element.clone() |
Element |
Element.closest(Evaluator evaluator)
Find the closest element up the tree of parents that matches the specified evaluator.
|
Element |
Element.closest(java.lang.String cssQuery)
Find the closest element up the tree of parents that matches the specified CSS query.
|
Element |
Document.createElement(java.lang.String tagName)
Create a new Element, with this document's base uri.
|
protected Element |
Element.doClone(Node parent) |
Element |
Element.empty()
Remove all the element's child nodes.
|
Element |
Element.expectFirst(java.lang.String cssQuery)
Just like
selectFirst(String) , but if there is no match, throws an IllegalArgumentException . |
Element |
Element.filter(NodeFilter nodeFilter) |
Element |
Element.firstElementChild()
Gets the first child of this Element that is an Element, or
null if there is none. |
Element |
Element.firstElementSibling()
Gets the first Element sibling of this element.
|
Element |
Element.forEach(java.util.function.Consumer<? super Element> action)
Perform the supplied action on this Element and each of its descendant Elements, during a depth-first traversal.
|
Element |
Element.forEach(Consumer<? super Element> action)
Deprecated.
Use
forEach(Consumer) instead. |
Element |
Element.forEachNode(java.util.function.Consumer<? super Node> action) |
private Element |
Node.getDeepChild(Element el) |
Element |
Element.getElementById(java.lang.String id)
Find an element by ID, including or under this element.
|
Element |
Document.head()
Get this document's
head element. |
Element |
Element.html(java.lang.String html)
Set this element's inner HTML.
|
private Element |
Document.htmlEl()
Find the root HTML element, or create it if it doesn't exist.
|
Element |
Element.id(java.lang.String id)
Set the
id attribute of this element. |
Element |
Element.insertChildren(int index,
java.util.Collection<? extends Node> children)
Inserts the given child nodes into this element at the specified index.
|
Element |
Element.insertChildren(int index,
Node... children)
Inserts the given child nodes into this element at the specified index.
|
Element |
Element.lastElementChild()
Gets the last child of this Element that is an Element, or @{code null} if there is none.
|
Element |
Element.lastElementSibling()
Gets the last element sibling of this element.
|
Element |
Element.nextElementSibling()
Gets the next sibling element of this element.
|
Element |
Element.parent() |
Element |
Element.prepend(java.lang.String html)
Add inner HTML into this element.
|
Element |
Element.prependChild(Node child)
Add a node to the start of this element's children.
|
Element |
Element.prependChildren(java.util.Collection<? extends Node> children)
Insert the given nodes to the start of this Element's children.
|
Element |
Element.prependElement(java.lang.String tagName)
Create a new element by tag name, and add it as the first child.
|
Element |
Element.prependText(java.lang.String text)
Create and prepend a new TextNode to this element.
|
Element |
Element.previousElementSibling()
Gets the previous element sibling of this element.
|
Element |
Element.removeAttr(java.lang.String attributeKey) |
Element |
Element.removeClass(java.lang.String className)
Remove a class name from this element's
class attribute. |
Element |
Element.root() |
Element |
Element.selectFirst(Evaluator evaluator)
Finds the first Element that matches the supplied Evaluator, with this element as the starting context, or
null if none match. |
Element |
Element.selectFirst(java.lang.String cssQuery)
Find the first Element that matches the
Selector CSS query, with this element as the starting context. |
Element |
Element.shallowClone() |
Element |
Element.tagName(java.lang.String tagName)
Change (rename) the tag of this element.
|
Element |
Element.text(java.lang.String text)
Set the text of this element.
|
Element |
Document.text(java.lang.String text)
Set the text of the
body of this document. |
Element |
Element.toggleClass(java.lang.String className)
Toggle a class name on this element's
class attribute: if present, remove it; otherwise add it. |
Element |
Element.traverse(NodeVisitor nodeVisitor) |
Element |
Element.val(java.lang.String value)
Set the value of a form element (input, textarea, etc).
|
Element |
Element.wrap(java.lang.String html)
Wrap the supplied HTML around this element.
|
Modifier and Type | Method and Description |
---|---|
(package private) java.util.List<Element> |
Element.childElementsList()
Maintains a shadow copy of this element's child elements.
|
Modifier and Type | Method and Description |
---|---|
FormElement |
FormElement.addElement(Element element)
Add a form control element to this form.
|
Element |
Element.appendTo(Element parent)
Add this element to the supplied parent element, as its next child.
|
private Element |
Node.getDeepChild(Element el) |
private static <E extends Element> |
Element.indexInList(Element search,
java.util.List<E> elements) |
private void |
Document.normaliseStructure(java.lang.String tag,
Element htmlEl) |
private void |
Document.normaliseTextNodes(Element element) |
private static java.lang.String |
Element.searchUpForAttribute(Element start,
java.lang.String key) |
(package private) static <T extends Node> |
NodeUtils.selectXpath(java.lang.String xpath,
Element el,
java.lang.Class<T> nodeType)
This impl works by compiling the input xpath expression, and then evaluating it against a W3C Document converted
from the original jsoup element.
|
Modifier and Type | Method and Description |
---|---|
Element |
Element.forEach(java.util.function.Consumer<? super Element> action)
Perform the supplied action on this Element and each of its descendant Elements, during a depth-first traversal.
|
Element |
Element.forEach(Consumer<? super Element> action)
Deprecated.
Use
forEach(Consumer) instead. |
Constructor and Description |
---|
NodeList(Element owner,
int initialCapacity) |
Modifier and Type | Field and Description |
---|---|
private Element |
HtmlTreeBuilder.contextElement |
private Element |
HtmlTreeBuilder.headElement |
Modifier and Type | Field and Description |
---|---|
private java.util.ArrayList<Element> |
HtmlTreeBuilder.formattingElements |
protected java.util.ArrayList<Element> |
TreeBuilder.stack |
Modifier and Type | Method and Description |
---|---|
(package private) Element |
HtmlTreeBuilder.aboveOnStack(Element el) |
protected Element |
TreeBuilder.currentElement()
Get the current element (last on the stack).
|
(package private) Element |
HtmlTreeBuilder.getActiveFormattingElement(java.lang.String nodeName) |
(package private) Element |
HtmlTreeBuilder.getFromStack(java.lang.String elName) |
(package private) Element |
HtmlTreeBuilder.getHeadElement() |
(package private) Element |
HtmlTreeBuilder.insert(Token.StartTag startTag) |
(package private) Element |
XmlTreeBuilder.insert(Token.StartTag startTag) |
(package private) Element |
HtmlTreeBuilder.insertEmpty(Token.StartTag startTag) |
(package private) Element |
HtmlTreeBuilder.insertStartTag(java.lang.String startTagName) |
(package private) Element |
HtmlTreeBuilder.lastFormattingElement() |
(package private) Element |
HtmlTreeBuilder.pop() |
(package private) Element |
HtmlTreeBuilder.popStackToClose(java.lang.String elName) |
(package private) Element |
HtmlTreeBuilder.removeLastFormattingElement() |
Modifier and Type | Method and Description |
---|---|
(package private) java.util.ArrayList<Element> |
HtmlTreeBuilder.getStack() |
Modifier and Type | Method and Description |
---|---|
(package private) Element |
HtmlTreeBuilder.aboveOnStack(Element el) |
(package private) void |
HtmlTreeBuilder.checkActiveFormattingElements(Element in) |
(package private) void |
HtmlTreeBuilder.insert(Element el) |
private void |
HtmlTreeBuilder.insert(Element el,
Token token) |
(package private) void |
HtmlTreeBuilder.insert(Token.Character characterToken,
Element el) |
(package private) void |
HtmlTreeBuilder.insertOnStackAfter(Element after,
Element in) |
(package private) boolean |
HtmlTreeBuilder.isInActiveFormattingElements(Element el) |
private boolean |
HtmlTreeBuilder.isSameFormattingElement(Element a,
Element b) |
(package private) boolean |
HtmlTreeBuilder.isSpecial(Element el) |
(package private) void |
HtmlTreeBuilder.maybeSetBaseUri(Element base) |
private static boolean |
HtmlTreeBuilder.onStack(java.util.ArrayList<Element> queue,
Element element) |
(package private) boolean |
HtmlTreeBuilder.onStack(Element el) |
static java.util.List<Node> |
Parser.parseFragment(java.lang.String fragmentHtml,
Element context,
java.lang.String baseUri)
Parse a fragment of HTML into a list of nodes.
|
static java.util.List<Node> |
Parser.parseFragment(java.lang.String fragmentHtml,
Element context,
java.lang.String baseUri,
ParseErrorList errorList)
Parse a fragment of HTML into a list of nodes.
|
(package private) abstract java.util.List<Node> |
TreeBuilder.parseFragment(java.lang.String inputFragment,
Element context,
java.lang.String baseUri,
Parser parser) |
(package private) java.util.List<Node> |
HtmlTreeBuilder.parseFragment(java.lang.String inputFragment,
Element context,
java.lang.String baseUri,
Parser parser) |
(package private) java.util.List<Node> |
XmlTreeBuilder.parseFragment(java.lang.String inputFragment,
Element context,
java.lang.String baseUri,
Parser parser) |
java.util.List<Node> |
Parser.parseFragmentInput(java.lang.String fragment,
Element context,
java.lang.String baseUri) |
(package private) int |
HtmlTreeBuilder.positionOfElement(Element el) |
(package private) void |
HtmlTreeBuilder.push(Element element) |
(package private) void |
HtmlTreeBuilder.pushActiveFormattingElements(Element in) |
(package private) void |
HtmlTreeBuilder.pushWithBookmark(Element in,
int bookmark) |
(package private) void |
HtmlTreeBuilder.removeFromActiveFormattingElements(Element el) |
(package private) boolean |
HtmlTreeBuilder.removeFromStack(Element el) |
(package private) void |
HtmlTreeBuilder.replaceActiveFormattingElement(Element out,
Element in) |
private void |
HtmlTreeBuilder.replaceInQueue(java.util.ArrayList<Element> queue,
Element out,
Element in) |
(package private) void |
HtmlTreeBuilder.replaceOnStack(Element out,
Element in) |
(package private) void |
HtmlTreeBuilder.setHeadElement(Element headElement) |
Modifier and Type | Method and Description |
---|---|
private static boolean |
HtmlTreeBuilder.onStack(java.util.ArrayList<Element> queue,
Element element) |
private void |
HtmlTreeBuilder.replaceInQueue(java.util.ArrayList<Element> queue,
Element out,
Element in) |
Modifier and Type | Field and Description |
---|---|
private Element |
Cleaner.CleaningVisitor.destination |
(package private) Element |
Cleaner.ElementMeta.el |
private Element |
Cleaner.CleaningVisitor.root |
Modifier and Type | Method and Description |
---|---|
private int |
Cleaner.copySafeNodes(Element source,
Element dest) |
private Cleaner.ElementMeta |
Cleaner.createSafeElement(Element sourceEl) |
protected boolean |
Safelist.isSafeAttribute(java.lang.String tagName,
Element el,
Attribute attr)
Test if the supplied attribute is allowed by this safelist for this tag
|
private boolean |
Safelist.testValidProtocol(Element el,
Attribute attr,
java.util.Set<Safelist.Protocol> protocols) |
Constructor and Description |
---|
CleaningVisitor(Element root,
Element destination) |
ElementMeta(Element el,
int numAttribsDiscarded) |
Modifier and Type | Field and Description |
---|---|
private Element |
Collector.FirstFinder.evalRoot |
private Element |
Collector.FirstFinder.match |
Modifier and Type | Method and Description |
---|---|
(package private) Element |
Collector.FirstFinder.find(Element root,
Element start) |
static Element |
Collector.findFirst(Evaluator eval,
Element root)
Finds the first Element that matches the Evaluator that descends from the root, and stops the query once that first
match is found.
|
Element |
Elements.first()
Get the first matched element.
|
Element |
Elements.last()
Get the last matched element.
|
static Element |
Selector.selectFirst(java.lang.String cssQuery,
Element root)
Find the first element that matches the query.
|
Modifier and Type | Method and Description |
---|---|
protected abstract int |
Evaluator.CssNthEvaluator.calculatePosition(Element root,
Element element) |
protected int |
Evaluator.IsNthChild.calculatePosition(Element root,
Element element) |
protected int |
Evaluator.IsNthLastChild.calculatePosition(Element root,
Element element) |
protected int |
Evaluator.IsNthOfType.calculatePosition(Element root,
Element element) |
protected int |
Evaluator.IsNthLastOfType.calculatePosition(Element root,
Element element) |
static Elements |
Collector.collect(Evaluator eval,
Element root)
Build a list of elements, by visiting root and every descendant of root, and testing it against the evaluator.
|
(package private) Element |
Collector.FirstFinder.find(Element root,
Element start) |
static Element |
Collector.findFirst(Evaluator eval,
Element root)
Finds the first Element that matches the Evaluator that descends from the root, and stops the query once that first
match is found.
|
boolean |
StructuralEvaluator.Root.matches(Element root,
Element element) |
boolean |
StructuralEvaluator.Has.matches(Element root,
Element element) |
boolean |
StructuralEvaluator.Not.matches(Element root,
Element node) |
boolean |
StructuralEvaluator.Parent.matches(Element root,
Element element) |
boolean |
StructuralEvaluator.ImmediateParent.matches(Element root,
Element element) |
boolean |
StructuralEvaluator.PreviousSibling.matches(Element root,
Element element) |
boolean |
StructuralEvaluator.ImmediatePreviousSibling.matches(Element root,
Element element) |
boolean |
CombiningEvaluator.And.matches(Element root,
Element node) |
boolean |
CombiningEvaluator.Or.matches(Element root,
Element node) |
abstract boolean |
Evaluator.matches(Element root,
Element element)
Test if the element meets the evaluator's requirements.
|
boolean |
Evaluator.Tag.matches(Element root,
Element element) |
boolean |
Evaluator.TagEndsWith.matches(Element root,
Element element) |
boolean |
Evaluator.Id.matches(Element root,
Element element) |
boolean |
Evaluator.Class.matches(Element root,
Element element) |
boolean |
Evaluator.Attribute.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeStarting.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeWithValue.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeWithValueNot.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeWithValueStarting.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeWithValueEnding.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeWithValueContaining.matches(Element root,
Element element) |
boolean |
Evaluator.AttributeWithValueMatching.matches(Element root,
Element element) |
boolean |
Evaluator.AllElements.matches(Element root,
Element element) |
boolean |
Evaluator.IndexLessThan.matches(Element root,
Element element) |
boolean |
Evaluator.IndexGreaterThan.matches(Element root,
Element element) |
boolean |
Evaluator.IndexEquals.matches(Element root,
Element element) |
boolean |
Evaluator.IsLastChild.matches(Element root,
Element element) |
boolean |
Evaluator.CssNthEvaluator.matches(Element root,
Element element) |
boolean |
Evaluator.IsFirstChild.matches(Element root,
Element element) |
boolean |
Evaluator.IsRoot.matches(Element root,
Element element) |
boolean |
Evaluator.IsOnlyChild.matches(Element root,
Element element) |
boolean |
Evaluator.IsOnlyOfType.matches(Element root,
Element element) |
boolean |
Evaluator.IsEmpty.matches(Element root,
Element element) |
boolean |
Evaluator.ContainsText.matches(Element root,
Element element) |
boolean |
Evaluator.ContainsWholeText.matches(Element root,
Element element) |
boolean |
Evaluator.ContainsWholeOwnText.matches(Element root,
Element element) |
boolean |
Evaluator.ContainsData.matches(Element root,
Element element) |
boolean |
Evaluator.ContainsOwnText.matches(Element root,
Element element) |
boolean |
Evaluator.Matches.matches(Element root,
Element element) |
boolean |
Evaluator.MatchesOwn.matches(Element root,
Element element) |
boolean |
Evaluator.MatchesWholeText.matches(Element root,
Element element) |
boolean |
Evaluator.MatchesWholeOwnText.matches(Element root,
Element element) |
boolean |
Evaluator.MatchText.matches(Element root,
Element element) |
static Elements |
Selector.select(Evaluator evaluator,
Element root)
Find elements matching selector.
|
static Elements |
Selector.select(java.lang.String query,
Element root)
Find elements matching selector.
|
static Element |
Selector.selectFirst(java.lang.String cssQuery,
Element root)
Find the first element that matches the query.
|
Modifier and Type | Method and Description |
---|---|
(package private) static Elements |
Selector.filterOut(java.util.Collection<Element> elements,
java.util.Collection<Element> outs) |
(package private) static Elements |
Selector.filterOut(java.util.Collection<Element> elements,
java.util.Collection<Element> outs) |
static Elements |
Selector.select(java.lang.String query,
java.lang.Iterable<Element> roots)
Find elements matching selector.
|
Constructor and Description |
---|
Elements(Element... elements) |
Constructor and Description |
---|
Elements(java.util.Collection<Element> elements) |
Elements(java.util.List<Element> elements) |