All Classes and Interfaces

Class
Description
A node containing the abbreviated text that will be rendered as an abbr tag or a link with title attribute
A block node that contains the abbreviation definition
 
 
 
Extension for adding abbreviations to markdown
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
An Admonition block node
 
 
 
 
 
Extension for admonitions
 
 
 
 
 
 
 
 
Anchor link node
Extension for anchor links
 
 
 
 
 
 
 
 
 
Abstract visitor that visits only children of blocks excluding Paragraphs
 
 
 
 
A ExtAside block node
 
 
 
 
Extension for ext_asides
 
 
 
 
 
 
 
Interface for subclassing by specific Node actions: visit, format, render, etc
AstActionHandler<C extends AstActionHandler<C,N,A,H>,N,A extends AstAction<N>,H extends AstHandler<N,A>>
Intended to be completed by subclasses for specific node types and node actions
 
 
AstHandler<N,A extends AstAction<? super N>>
Base class for tracking generic node to specific node handler
Interface for converting to AstAccess
Specifies the node part for which attributes can be provided
 
 
 
An Attribute node representing a single attribute name and value in attributes node
 
Extension point for adding/changing attributes on the primary HTML tag for a node.
 
 
 
 
 
 
 
A empty implicit AttributesNode used to mark attribute span start
Extension for attributes
 
 
 
A AttributesNode node
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Extension for automatically turning plain URLs and email addresses into links.
 
 
 
 
 
Implemented by BasedOptionsSequence, use instance of it to pass to BasedSequence.of(CharSequence) and options enabled in it will be accessible to all based sequences or uses of these for testing for options or getting options.
 
A BasedSequence with offset tracking that follows editing operations and subSequence() chopping as best as it can
 
A CharSequence that references original char sequence with offsets into original preserved.
 
Implementation of BaseSequence
 
 
 
 
BitFieldSet<E extends Enum<E>>
Re-Implementation of RegularEnumSet class for EnumSet, for "regular sized" enum types (i.e., those with 64 or fewer enum constants)
This class is used to serialize all EnumSet instances, regardless of implementation type.
 
 
 
 
 
Implemented by nodes after which text collecting visitor should add a line break regardless of whether there is a previous line break
 
 
 
 
Result object for continuing parsing of a block, see static methods for constructors.
 
Used to visit only block nodes, non block nodes or children of non-block nodes are not visited
Parser for a specific block node.
Parser factory for a block node for determining when a block starts.
 
 
 
 
 
 
 
 
 
 
Result object for starting parsing of a block, see static methods for constructors.
 
 
 
 
 
 
 
Opening bracket for links ([) or images (![).
 
 
 
 
 
 
 
 
 
Interface for set of characters to use for inclusion exclusion tests Can be used for code points since the argument is int
 
A CharSequence that references original char[] a subSequence() returns a sub-sequence from the original base sequence
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A node that uses delimiters in the source form (e.g.
 
 
 
 
The node renderer that renders all the core nodes (comes last in the order of node renderers).
 
Custom block parser factory to create parser instance specific block parser factory
CustomHtmlNodeRenderer<N extends org.jsoup.nodes.Node>
 
 
NOTE: Constructors have changed in a breaking way from 0.50.x and prior implementations
 
 
 
 
 
 
 
Extension for definitions
 
A Definition item block node, starts with : followed by any content like a list item
 
 
 
 
 
A DefinitionList block node
 
 
 
 
 
 
 
 
 
 
A Definition block node
 
 
Factory for instantiating new node renderers when rendering is done.
Factory for instantiating new node renderers when rendering is done.
Factory for instantiating new node renderers with dependencies
Factory for instantiating new node renderers with dependencies
 
 
 
 
 
Custom delimiter processor for additional delimiters besides _ and *.
A delimiter run is one or more of the same delimiter character.
Deprecated.
use DependencyResolver instead
 
 
 
 
 
 
 
 
 
 
 
 
 
 
To be implemented by nodes marking their text as not for attachment by attributes
To be implemented by nodes marking their text as not for collection
To be implemented by nodes marking their text as not for conversion to links or other decoration methods by extensions
To be implemented by nodes marking their text as not for conversion to links or other decoration methods by extensions
To be implemented by nodes marking their text as not to be trimmed because they represent whitespace or EOL text
 
 
 
 
 
 
Provider which will provide attributes stored in the node's first EmbeddedAttributeProvider.EmbeddedNodeAttributes of the node's children
 
 
 
 
An emoji node containing emoji shortcut text
 
Extension for emoji shortcuts using Emoji-Cheat-Sheet.com.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A EnumeratedReference node
A EnumeratedReference block node
 
 
 
Extension for enumerated_references
 
A EnumeratedReference node
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A EnumeratedReference node
 
 
 
 
 
A EscapedCharacter node
Extension for escaped_characters
 
 
 
 
 
 
 
 
 
 
 
 
Base interface for a parser/renderer extension.
 
 
 
 
 
 
 
 
 
Generic class to use as after dependents to ensure dependent is first in list
 
Deprecated.
use DependencyResolver.resolveFlatDependencies(List, Function, Function) use null for functions if no need for sort or class extractor
Renders a tree of nodes to HTML.
Builder for configuring an FlexmarkHtmlConverter.
Extension for FlexmarkHtmlConverter.
 
 
 
 
 
 
 
 
A Footnote referencing node
A Footnote definition node containing text and other inline nodes nodes as children.
 
 
 
Extension for footnotes
 
 
 
 
 
 
 
 
 
 
 
 
 
Renders a tree of nodes to Markdown.
Builder for configuring an Formatter.
Extension for Formatter.
 
 
 
 
 
 
A GfmIssue node
Extension for GitHub Issues
 
 
 
 
 
 
 
 
 
A GfmUser node
Extension for GitHub Users
 
 
 
 
 
 
 
 
 
A GitLab block node
 
 
 
A Del node
Extension for git_labs
A Ins node
A Ins node
 
 
 
 
A Ins node
 
 
 
 
 
 
 
 
 
 
Factory for instantiating an HTML id generator
 
 
 
 
 
 
 
 
 
 
Used to help with HTML output generation and formatting of HTML
 
HTML block
HTML block
 
 
 
 
 
HTML block
 
 
 
 
 
 
 
Inline HTML element.
 
 
Factory for instantiating new node renderers when rendering is done.
Inline HTML element.
Inline HTML element.
Inline HTML comment element.
Inline HTML element.
Inline HTML element.
 
 
 
 
 
The context for node rendering, including configuration and functionality for the node renderer to use.
 
A renderer for a set of node types.
Factory for instantiating new node renderers when rendering is done.
HtmlNodeRendererHandler<N extends org.jsoup.nodes.Node>
 
Renders a tree of nodes to HTML.
Builder for configuring an HtmlRenderer.
Extension for HtmlRenderer.
 
 
 
 
 
 
 
 
Immutable<I extends Immutable<I,M>,M extends Mutable<M,I>>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Parser for inline content (text, links, emphasized text, etc).
 
 
 
 
 
 
 
 
 
A Ins node
 
Extension for ins
 
 
 
 
 
 
Interface to generic parser for RenderingTestCase customizations
 
IPosition<T,P extends IPosition<T,P>>
Represents a position in the list at the given index and with a span of 0 or 1 elements.
 
 
 
 
 
Render interface for rendering implementation for RenderingTestCase
 
A CharSequence that provides a rich set of manipulation methods.
An abstract base for RichSequence which implements most of the methods allowing subclasses to implement RichSequence with minimal support methods
 
 
 
 
 
 
 
 
A JekyllFrontMatter block node
 
 
 
Extension for jekyll_front_matters
 
 
 
 
 
 
A JekyllTag node
A JekyllTag block node
 
 
 
Extension for jekyll_tags
 
 
 
 
 
 
 
 
 
Extension for jira_converters
 
 
 
 
 
 
Generic class to use as before dependents to ensure dependent is last in list
 
 
Used to collect line text for further processing
 
 
 
 
Implemented by nodes after which text collecting visitor should add a line break
 
Line information in LineAppendable
 
 
 
 
 
 
 
 
Nodes which are textually derived from LinkRef
Processing of elements which are based on a link ref: [] or ![] This includes footnote references [^...] and wiki links [[...]]
 
Processing of elements which are based on a link ref: [] or ![] This includes footnote references [^...] and wiki links [[...]]
Nodes which are textually derived from LinkRef
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A macros node
A macros node
A macros block node
 
 
 
A macros node
A MacroReference block node
 
 
 
 
Extension for macros
 
 
 
 
 
 
 
A MacroReference node
Extension for macros
 
 
 
 
 
 
 
 
 
 
 
 
 
A BasedSequence which maps characters according to CharMapper
MappedIterator<B,T extends B>
 
A CharSequence that maps characters according to CharMapper
A CharSequence that maps characters according to CharMapper
 
 
 
 
 
 
 
 
 
 
 
Open block parser that was last matched during the continue phase.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Mutable<M extends Mutable<M,I>,I extends Immutable<I,M>>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A renderer for a set of node types.
The context for node rendering, including configuration and functionality for the node renderer to use.
Factory for instantiating new node renderers when rendering is done.
 
 
 
 
 
 
 
 
A renderer for a set of node types.
The context for node rendering, including configuration and functionality for the node renderer to use.
Factory for instantiating new node renderers when rendering is done.
Factory for instantiating new node renderers when rendering is done.
 
 
 
 
NodeRenderingHandlerWrapper<N extends org.jsoup.nodes.Node>
 
 
 
 
Interface to visit variations on specific nodes: visit() visiting node and if no handler defined then visit node's children visitNodeOnly() visit node and if no handler then do not process children visitChildren() visit node's children
 
Abstract visitor that visits all children by default.
Non rendering inline node, paragraphs containing only these types are not rendered because they are empty
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Parses input text to a tree of nodes.
Builder for configuring a Parser.
Extension for Parser.
Should be implemented by all extensions that create a node repository or other references in the document.
 
 
 
Current Parser Phase as the document is parsed.
State of the parser that is used in block parsers.
 
 
 
A renderer for a document node for a specific rendering phase
A renderer for a document node for a specific rendering phase
A renderer for a document node for a specific rendering phase
 
 
 
Used to replace placeholder text in the form of open/close char such as <text> in a markdown document.
 
 
 
 
Bidirectional iterator, direction depends on the position anchor NEXT is a forward iterator, PREVIOUS is a reverse iterator
 
Iterator for list positions allowing to iterate over current elements while inserting and deleting elements relative to current position
 
 
 
 
 
A BasedSequence with an out of scope of original char sequence prefix
 
 
 
 
ReferenceNode<R extends NodeRepository<B>,B extends Node,N extends Node>
 
 
 
 
 
 
Extension point for RenderingExtensions that only provide attributes, link resolvers or html id generators
 
 
 
 
 
CharSequence that repeats in a wraparound the given sequence.
Interface implemented by sequences which do not contain contiguous base characters from startOffset to endOffset
Class which tracks text replacements to provide original offset from modified offset.
 
 
 
 
 
 
 
 
 
 
 
 
 
Used to resolve test resource URL from copy in test location to URL of source file
 
 
 
 
 
 
 
 
 
A Builder for non based strings.
A RichSequence implementation
 
 
Representation of a segment part in a segment list for a sequence it is a Range, either in the base sequence or in the out of base characters for the builder.
SegmentedSequence Segment stored in byte[] in serialized format
 
 
 
 
 
 
 
 
 
 
 
A BasedSequence which consists of segments of other BasedSequences
A BasedSequence which consists of segments of other BasedSequences NOTE: very efficient for random access but extremely wasteful with space by allocating 4 bytes per character in the sequence with corresponding construction penalty use SegmentedSequenceTree which is binary tree based segmented sequence with minimal overhead and optimized to give penalty free random access for most applications.
 
 
A BasedSequence which consists of segments of other BasedSequences NOTE: very efficient for random access but extremely wasteful with space by allocating 4 bytes per character in the sequence with corresponding construction penalty use SegmentedSequenceTree which is binary tree based segmented sequence with minimal overhead and optimized to give penalty free random access for most applications.
 
Segment tree which uses offsets instead of aggregated length of segments
 
 
Binary search tree of sequence segments
 
 
Class used to extract subSequence information from segment tree
A Builder for Segmented BasedSequences
 
Instance based on aggregated options used for spec test settings which itself is part of a settable instance
Instance based on aggregated options used for spec test settings which may contain other such settings which can be accessed through other data keys directly
 
A simulated toc block node
 
 
 
 
A sim toc contents node containing all text that came after the sim toc node
Extension for tocs
 
 
 
 
 
A sim toc contents node containing all text that came after the sim toc node
A sim toc contents node containing all text that came after the sim toc node
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A SpecExample block node
A SpecExample block node
 
 
 
Extension for spec_examples
A SpecExample block node
 
 
 
 
A SpecExample block node
 
A SpecExample block node
A SpecExample block node
 
 
 
 
A SpecExample block node
A SpecExample block node
 
 
 
 
 
 
 
 
A strikethrough node containing text and other inline nodes nodes as children.
 
Extension for GFM strikethrough using ~~ (GitHub Flavored Markdown).
 
 
 
 
 
Extension for GFM strikethrough using ~~ (GitHub Flavored Markdown).
 
 
 
 
 
A Builder for non based strings.
 
 
A Subscript node containing text and other inline nodes nodes as children.
 
Extension for GFM strikethrough using ~~ (GitHub Flavored Markdown).
 
 
A BasedSequence implementation which wraps original CharSequence to provide a BasedSequence for all its subsequences, a subSequence() returns a SubSequence from the original base sequence.
A Superscript node
 
Extension for superscripts
 
 
 
 
 
 
Table block containing a TableHead and optionally a TableBody.
Body part of a TableBlock containing TableRows.
Table caption of a TableBlock containing inline nodes.
 
 
 
Table cell of a TableRow containing inline nodes.
 
How the cell is aligned horizontally.
 
 
 
Table cell separator only used during parsing, not part of the AST, use the TableCell.getOpeningMarker() and TableCell.getClosingMarker()
 
 
 
Head part of a TableBlock containing TableRows.
 
 
 
 
 
 
 
 
 
 
Table row of a TableHead or TableBody containing TableCells.
 
 
 
 
Body part of a TableBlock containing TableRows.
 
 
Extension for GFM tables using "|" pipes (GitHub Flavored Markdown).
Deprecated.
use TextCollectingVisitor from the utils library
 
 
 
 
Extension for GFM style task list items
 
A Task list item
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Deprecated.
use TextCollectingVisitor from the utils library
 
 
 
 
 
 
 
 
 
 
A TOC node
A TOC node
 
 
 
 
Extension for tocs
 
 
 
 
 
 
 
 
 
 
 
 
 
Tracked Offset information
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Extension for typographics
 
 
 
A TypographicQuotes node
A TypographicSmarts node
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Node visit handler for specific node type
Visitor<N extends Node>
Node visitor interface
 
 
 
Only generated for CharacterNodeFactory custom parsing
 
 
 
 
Extension for wikilinks
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Extension for YAML-like metadata.
 
 
 
 
 
 
Extension for youtrack_converters
 
 
 
 
 
 
 
 
 
 
A Zzzzzz node
 
 
A Zzzzzz block node
 
 
 
 
 
 
 
 
Extension for zzzzzzs