jruby
/
docs
BETA
Home
Libraries
jsoup
Recipes
Search docs, classes, methods…
⌘
K
jsoup (JRuby)
127 classes
21 packages
19 public · 2 internal
org.jsoup
6
I
Connection
— The Connection interface is a convenient HTTP client and session object to fetch content from the web, and parse them into Documents.
C
HttpStatusException
— Signals that a HTTP request resulted in a not OK HTTP response.
C
Jsoup
— The core public access point to the jsoup functionality.
I
Progress
C
SerializationException
— A SerializationException is raised whenever serialization of a DOM element fails.
C
UnsupportedMimeTypeException
— Signals that a HTTP response returned a mime type that is not supported.
org.jsoup.Connection
5
I
Base
— Common methods for Requests and Responses
I
KeyVal
— A Key:Value tuple(+), used for form data.
E
Method
— GET and POST http methods.
I
Request
— Represents a HTTP request.
I
Response
— Represents a HTTP response.
org.jsoup.examples
3
C
HtmlToPlainText
— HTML to plain-text.
C
ListLinks
— Example program to list links from a URL.
C
Wikipedia
— A simple example, used on the jsoup website.
org.jsoup.helper
7
C
DataUtil
— Internal static utilities for handling data.
C
HttpConnection
— Implementation of Connection.
C
Regex
— A regular expression abstraction.
I
RequestAuthenticator
— A RequestAuthenticator is used in Connection to authenticate if required to proxies and web servers.
C
Validate
— Validators to check that method arguments meet expectations.
C
ValidationException
— Validation exceptions, as thrown by the methods in Validate.
C
W3CDom
— Helper class to transform a org.jsoup.nodes.Document to a org.w3c.dom.Document, for integration with toolsets that use the W3C DOM.
org.jsoup.helper.HttpConnection
3
C
KeyVal
C
Request
C
Response
org.jsoup.helper.Regex
1
I
Matcher
org.jsoup.helper.RequestAuthenticator
1
C
Context
— Provides details for the request, to determine the appropriate credentials to return.
org.jsoup.nodes
17
C
Attribute
— A single key + value attribute.
C
Attributes
— The attributes of an Element.
C
CDataNode
— A Character Data node, to support CDATA sections.
C
Comment
— A comment node.
C
DataNode
— A data node, for contents of style, script tags etc, where contents should not show in text().
C
Document
— A HTML Document.
C
DocumentType
— A <!DOCTYPE> node.
C
Element
— An HTML Element consists of a tag name, attributes, and child nodes (including text nodes and other elements).
C
Entities
— HTML entities, and escape routines.
C
FormElement
— An HTML Form Element provides ready access to the form fields/controls that are associated with it.
C
LeafNode
— A node that does not hold any children.
C
Node
— The base, abstract Node model.
C
NodeIterator
— Iterate through a Node and its tree of descendants, in document order, and returns nodes of the specified type.
C
PseudoTextElement
— Represents a TextNode as an Element, to enable text nodes to be selected with the org.jsoup.select.Selector :matchText syntax.
C
Range
— A Range object tracks the character positions in the original input source where a Node starts or ends.
C
TextNode
— A text node.
C
XmlDeclaration
— An XML Declaration.
org.jsoup.nodes.Document
2
C
OutputSettings
— A Document's output settings control the form of the text() and html() methods.
E
QuirksMode
org.jsoup.nodes.Document.OutputSettings
1
E
Syntax
— The output serialization syntax.
org.jsoup.nodes.Entities
1
E
EscapeMode
org.jsoup.nodes.Range
2
C
AttributeRange
C
Position
— A Position object tracks the character position in the original input source where a Node starts or ends.
org.jsoup.parser
11
C
CharacterReader
— CharacterReader consumes tokens off a string.
C
HtmlTreeBuilder
— HTML Tree Builder; creates a DOM from Tokens.
C
ParseError
— A Parse Error records an error in the input HTML that occurs in either the tokenisation or the tree building phase.
C
ParseErrorList
— A container for ParseErrors.
C
ParseSettings
— Controls parser case settings, to optionally preserve tag and/or attribute name case.
C
Parser
— Parses HTML or XML into a org.jsoup.nodes.Document.
C
StreamParser
— A StreamParser provides a progressive parse of its input.
C
Tag
— A Tag represents an Element's name and configured options, common throughout the Document.
C
TagSet
— A TagSet controls the Tag configuration for a Document's parse, and its serialization.
C
TokenQueue
— A character reader with helpers focusing on parsing CSS selectors.
C
XmlTreeBuilder
— Use the XmlTreeBuilder when you want to parse XML without any of the HTML DOM rules being applied to the document.
org.jsoup.safety
2
C
Cleaner
— The Safelist-based HTML cleaner.
C
Safelist
— Safelists define what HTML (elements and attributes) to allow through a Cleaner.
org.jsoup.select
10
C
Collector
— Collects a list of elements that match the supplied criteria.
C
CombiningEvaluator
— Base combining (and, or) evaluator.
C
Elements
— A list of Elements, with methods that act on every element in the list.
C
Evaluator
— An Evaluator tests if an element (or a node) meets the selector's requirements.
I
NodeFilter
— A controllable Node visitor interface.
C
NodeTraversor
— A depth-first node traversor.
I
NodeVisitor
— Node visitor interface, used to walk the DOM and visit each node.
C
Nodes
— A list of Node objects, with methods that act on every node in the list.
C
QueryParser
— Parses a CSS selector into an Evaluator tree.
C
Selector
— CSS element selector, that finds elements matching a query.
org.jsoup.select.CombiningEvaluator
2
C
And
C
Or
org.jsoup.select.Evaluator
42
C
AllElements
— Evaluator for any / all element matching
C
Attribute
— Evaluator for attribute name matching
C
AttributeKeyPair
— Abstract evaluator for attribute name/value matching
C
AttributeStarting
— Evaluator for attribute name prefix matching
C
AttributeWithValue
— Evaluator for attribute name/value matching
C
AttributeWithValueContaining
— Evaluator for attribute name/value matching (value containing)
C
AttributeWithValueEnding
— Evaluator for attribute name/value matching (value ending)
C
AttributeWithValueMatching
— Evaluator for attribute name/value matching (value regex matching)
C
AttributeWithValueNot
— Evaluator for attribute name != value matching
C
AttributeWithValueStarting
— Evaluator for attribute name/value matching (value prefix)
C
Class
— Evaluator for element class
C
ContainsData
— Evaluator for matching Element (and its descendants) data
C
ContainsOwnText
— Evaluator for matching Element's own text
C
ContainsText
— Evaluator for matching Element (and its descendants) text
C
ContainsWholeOwnText
— Evaluator for matching Element (but not its descendants) wholeText.
C
ContainsWholeText
— Evaluator for matching Element (and its descendants) wholeText.
C
CssNthEvaluator
C
Id
— Evaluator for element id
C
IndexEquals
— Evaluator for matching by sibling index number (e = idx)
C
IndexEvaluator
— Abstract evaluator for sibling index matching
C
IndexGreaterThan
— Evaluator for matching by sibling index number (e > idx)
C
IndexLessThan
— Evaluator for matching by sibling index number (e < idx)
C
IsEmpty
C
IsFirstChild
— Evaluator for matching the first sibling (css :first-child)
C
IsFirstOfType
C
IsLastChild
— Evaluator for matching the last sibling (css :last-child)
C
IsLastOfType
C
IsNthChild
— css-compatible Evaluator for :eq (css :nth-child)
C
IsNthLastChild
— css pseudo class :nth-last-child)
C
IsNthLastOfType
C
IsNthOfType
— css pseudo class nth-of-type
C
IsOnlyChild
C
IsOnlyOfType
C
IsRoot
— css3 pseudo-class :root
C
MatchText
C
Matches
— Evaluator for matching Element (and its descendants) text with regex
C
MatchesOwn
— Evaluator for matching Element's own text with regex
C
MatchesWholeOwnText
— Evaluator for matching Element's own whole text with regex.
C
MatchesWholeText
— Evaluator for matching Element (and its descendants) whole text with regex.
C
Tag
— Evaluator for tag name
C
TagEndsWith
— Evaluator for tag name that ends with suffix; used for *|el
C
TagStartsWith
— Evaluator for tag name that starts with prefix; used for ns|*
org.jsoup.select.NodeFilter
1
E
FilterResult
— Traversal action.
org.jsoup.select.Selector
1
C
SelectorParseException
Internal packages
org.jsoup.internal
8
C
ControllableInputStream
— A jsoup internal class (so don't use it as there is no contract API) that enables controls on a buffered input stream, namely a maximum read size, and
C
Functions
— An internal class containing functions for use with Map#computeIfAbsent(Object, Function).
C
Normalizer
— Util methods for normalizing strings.
C
QuietAppendable
— A jsoup internal class to wrap an Appendable and throw IOExceptions as SerializationExceptions.
C
SharedConstants
— jsoup constants used between packages.
C
SimpleStreamReader
— A simple decoding InputStreamReader that recycles internal buffers.
C
SoftPool
— A SoftPool is a ThreadLocal that holds a SoftReference to a pool of initializable objects.
C
StringUtil
— A minimal String utility class.
org.jsoup.internal.StringUtil
1
C
StringJoiner
— A StringJoiner allows incremental / filtered joining of a set of stringable objects.
⌘K
↵
open
↑
↓
navigate
esc
close
⌘
B
bookmark
ask AI
Keyboard shortcuts
Open command palette
⌘
K
Toggle theme
⌘
D
Switch version
⌘
V
Next member
]
Previous member
[
Focus class list
g
then
c
Focus member list
g
then
m
Toggle focus mode
f
Next class
j
Previous class
k
Show this overlay
?
Close any overlay
esc
press
esc
or click outside to dismiss