flexmark-java - project architecture overview

println()

external

class? PrintStream

builder()

IParse

class Parser

Parses input text to a tree of nodes. Start with the #builder method, configure the ...

build()

BuilderBase

class Parser.Builder

Builder for configuring a Parser .

Create a new builder for configuring an {@link Formatter}.

builder()

IRender

class Formatter

Renders a tree of nodes to Markdown. Start with the #builder method to configure the...

build()

BuilderBase

class Formatter.Builder

Builder for configuring an Formatter . See methods for default configuration.

Parse the specified input text into a tree of nodes. Note that this method is th...

parse()

AstCollectingVisitor()

external

class AstCollectingVisitor

collectAndGetAstText()

Render the tree of nodes to markdown

Builder()

loadExtensions()

MutableDataSet

abstract class BuilderBase

contains()

DataHolder

class DataSet

get()

DataKeyBase

class DataKey

NOTE: Constructors have changed in a breaking way from 0.50.x and prior implementati...

extensions()

size()

external

class? Collection

Preload operation for extension, perform any data config and other operation needed ...

preloadExtension()

Load extension if it is valid

loadExtension()

set()

Tracks keys set by extension initialization

addExtensionApiPoint()

Call to add extension API point to track

Parser()

toImmutable()

DataSet...

class MutableDataSet

calculateBlockParserFactories()

ParserState

class DocumentParser

getLeadInHandler()

Dependent

interface CustomBlockParserFactory

Custom block parser factory to create parser instance specific block parser factory

calculateParagraphPreProcessors()

MutableDataSet()

set()

calculateBlockPreProcessors()

calculateDelimiterProcessors()

LightInlineParserImpl...

class InlineParserImpl

calculateDelimiterCharacters()

calculateLinkRefProcessors()

calculateSpecialCharacters()

calculatePostProcessors()

class PostProcessorManager

MutableDataSetter

interface DataHolder

resolveFlatDependencies()

class DependencyResolver

resolveDependencies()

DependentItemMap()

OrderedMap

class DependentItemMap

external

interface Function

containsKey()

class OrderedMap

size()

affectsGlobalScope()

interface Dependent

class DependentItem

getBeforeDependents()

class Ref

class OrderedSet

getIndexedValueProxy()

indexIterable()

IndexedIterable()

ReversibleIndexedIterable

class IndexedIterable

Indexed<V>Anonymous()

class OrderedMap.Indexed<V>Anonymous

BitSetIterable()

ReversibleIterable

class BitSetIterable

ReversibleIndexedIterator

class IndexedIterator

BitSetIterator()

ReversibleIterator

class BitSetIterator

AsteriskDelimiterProcessor()

BitSetIterator()

isValidIndex()

set()

EmphasisDelimiterProcessor

class AsteriskDelimiterProcessor

UnderscoreDelimiterProcessor()

addDelimiterProcessors()

EmphasisDelimiterProcessor

class UnderscoreDelimiterProcessor

getOpeningCharacter()

interface DelimiterProcessor

Custom delimiter processor for additional delimiters besides _ and * . Note that imp...

addDelimiterProcessorForChar()

getClosingCharacter()

getCanonicalName()

external

class? Class

Whether the element consists of nested [] inside the link ref. For example Wiki link...

getBracketNestingLevel()

interface LinkRefProcessorFactory

Processing of elements which are based on a link ref: [] or ![] This includes footno...

getWantExclamationPrefix()

Whether the image ref is desired, if not then ! will be stripped off the prefix and ...

LinkRefProcessorData()

class LinkRefProcessorData

PostProcessorDependencyStage()

class PostProcessorManager.PostProcessorDependencyStage

A map of nodes of interest as keys and values a set of classes, if implemented by an...

getNodeTypes()

Dependent

interface PostProcessorFactory

Builder()

Formatter()

Factory()

HeaderIdGeneratorFactory

class HeaderIdGenerator.Factory

calculateNodeFormatterFactories()

Factory()

NodeFormatterFactory

class CoreNodeFormatter.Factory

inlineParser()

interface InlineParserFactory

DocumentParser()

of()

IRichSequence...

interface BasedSequence

A CharSequence that references original char sequence with offsets into original pre...

The main parsing function. Returns a parsed document AST.

parse()

postProcess()

getParsing()

interface LightInlineParser

DocumentBlockParser()

AbstractBlockParser...

class DocumentBlockParser

activateBlockParser()

containsKey()

BlockTracker...

class ClassifyingBlockTracker

blockParserAdded()

containsKey()

class OrderedMultiMap

interface BlockParser

Parser for a specific block node. Implementations should subclass AbstractBlockParse...

putKeyValue()

IRichSequenceBase...

abstract class BasedSequenceImpl

Implementation of BaseSequence

BasedSequenceImpl

class SubSequence

A BasedSequence implementation which wraps original CharSequence to provide a BasedS...

LightInlineParser

interface InlineParser

Parser for inline content (text, links, emphasized text, etc). This interface is not...

Get a portion of this sequence

class Parsing

incorporateLine()

Analyze a line of text and update the document appropriately. We parse markdown text...

finalizeAndProcess()

Document()

Block...

class Document

indexOfAny()

interface SequenceUtils

indexOfAny()

test()

interface CharPredicate

Interface for set of characters to use for inclusion exclusion tests Can be used for...

abstract class Node

BlankLine()

Block

class BlankLine

setClaimedBlankLine()

See if the block parser can continue parsing the current block

tryContinue()

isFinalize()

BlockContinue

class BlockContinueImpl

Finalize a block. Close it and do any necessary postprocessing, e.g. creating string...

finalize()

getClaimedBlankLine()

isLastLineBlank()

breakOutOfLists()

Break out of all containing lists, resetting the tip of the document to the parent o...

Allows block parsers to be interrupted by other block parsers

isInterruptible()

Allows block parsers to keep indenting spaces for those blocks that are interruptibl...

finalizeBlocks()

Finalize blocks of previous line.

getNewIndex()

BlockStart

class BlockStartImpl

isReplaceActiveBlockParser()

getNewColumn()

removeActiveBlockParser()

getBlockParsers()

addChild()

Add block parser of type T as a child of the currently active parsers. If the tip ca...

getActiveBlockParser()

Add line content to the active block parser. We assume it can accept lines -- that c...

isParagraphParser()

addLine()

propagateLastLineBlank()

BlankLine()

ParagraphParser()

AbstractBlockParser

class ParagraphParser

unlink()

setParent()

setCharsFromContent()

SequenceUtils

interface IRichSequence

A CharSequence that provides a rich set of manipulation methods. NOTE: '\0' changed ...

setChars()

Get the start offset of this sequence into {@link #getBaseSequence()} and {@link #ge...

getStartOffset()

class Utils

Get the end offset of this sequence into {@link # getBaseSequence()} and {@link #getB...

max()

Get a portion of this sequence's base sequence NOTE: this means that if this seq...

baseSubSequence()

deactivateBlockParser()

getParent()

ContentNode

abstract class Block

Append all from child to end of chain to this node

getLastChild()

getFirstInChain()

insertChainAfter()

setCharsFromContentOnly()

closeBlock()

Used to clean up and prepare for the next parsing run of the AbstractBlockParser for...

finalizeClosedBlock()

columnsToNextTabStop()

breakOutOnDoubleBlankLine()

MatchedBlockParserImpl()

MatchedBlockParser

class MatchedBlockParserImpl

Allows block parsers to determine if they can be interrupted by other block parsers

canInterruptBy()

tryStart()

interface BlockParserFactory

Parser factory for a block node for determining when a block starts. Implementations...

interface CollectionHost

getValue()

Pair()

Paired

class Pair

Get a portion of this sequence starting from a given offset to endIndex of the seque...

prefixOf()

BasedSequenceImpl...

class PrefixedSubSequence

A BasedSequence with an out of scope of original char sequence prefix a subSequence(...

Add another line to the block

addLine()

prefixOf()

PrefixedSubSequence()

setLastLineBlank()

isPropagatingLastBlankLine()

getParent()

preProcessParagraphs()

preProcessBlocks()

processInlines()

Walk through a block & children recursively, parsing string content into inline cont...

class ClassificationBag

ParagraphPreProcessorCache()

ItemFactoryMap

class DocumentParser.ParagraphPreProcessorCache

pre-process a paragraph block

getCategoryItems()

preProcessParagraph()

class ItemFactoryMap

Process Paragraph Content on closing of the paragraph block to removeIndex non-text ...

interface ParagraphPreProcessor

Node...

abstract class ContentNode

getLineChars()

setContent()

Block...

class Paragraph

Block types that this pre-processors processes

Dependent

interface BlockPreProcessorFactory

Create a paragraph pre processor for the document

Called on block nodes of interest as given by the NodePreProcessorFactory after all ...

preProcess()

interface BlockPreProcessor

get()

IndexedItemSetMap

abstract class IndexedItemSetMapBase

getConcurrentModsIndexedProxy()

IndexedProxy()

Indexed

class OrderedSet.IndexedProxy

Do inline processing for the block content using the given inline parser interface

keySet()

processDocument()

PostProcessorManager()

interface PostProcessor

NodeClassifierVisitor()

NodeVisitorBase...

class NodeClassifierVisitor

classify()

getExclusionSet()

NodeTracker

class ClassifyingNodeTracker

ClassifyingNodeTracker()

interface ReversibleIterable

CollectionHost<V>Anonymous()

addAll()

ClassificationBag()

class ClassificationBag.CollectionHost<V>Anonymous

OrderedSet()

IndexedItemBitSetMap()

IndexedItemSetMapBase

class IndexedItemBitSetMap

CollectionHost<K>Anonymous()

IndexedItemBitSetMap()

OrderedMap()

class OrderedMap.CollectionHost<K>Anonymous

entrySet()

external

interface Map

getKey()

external

interface Map$Entry

Visit the child nodes.

interface NodeTracker

Render a node to the appendable NOTE: if Appendable is LineAppendable then its b...

class CopyOnWriteRef

Render node NOTE: if Appendable is LineAppendable then its builder will be used ...

MarkdownWriter()

MarkdownWriterBase

class MarkdownWriter

getDocument()

MainNodeFormatter()

NodeFormatterSubContext

class Formatter.MainNodeFormatter

appendToSilently()

interface LineAppendable

Used to collect line text for further processing control output of new lines limitin...

Construct sequence from this builder using another based sequence which is character...

toSequence()

ISequenceBuilder

class SequenceBuilder

A Builder for Segmented BasedSequences

getUnresolvedOffsets()

class TrackedOffsetList

Resolve any unresolved tracked offsets

resolveTrackedOffsets()

class TrackedOffsetUtils

ScopedDataSet()

DataSet

class ScopedDataSet

FormatterOptions()

class FormatterOptions

values()

enum FormattingPhase

COLLECT,DOCUMENT_FIRST,DOCUMENT_TOP,DOCUMENT, DOCUMENT_BOTTOM

Dependent

interface LinkResolverFactory

Factory()

LinkResolverFactory

class MergeLinkResolver.Factory

setContext()

LineAppendable

abstract class MarkdownWriterBase

Create a new node renderer for the specified rendering context.

Dependent

interface NodeFormatterFactory

Factory for instantiating new node renderers when rendering is done.

getBlockQuoteLikePrefixChar()

Return character which compacts like block quote prefix

interface NodeFormatter

A renderer for a set of node types.

getNodeFormattingHandlers()

getNodeType()

abstract class AstHandler

Base class for tracking generic node to specific node handler

Collect nodes of given type so that they can be quickly accessed without traversing ...

getNodeClasses()

getFormattingPhases()

NodeFormatter

interface PhasedNodeFormatter

A renderer for a document node for a specific rendering phase

Comparison to another CharSequence should result in a match if their contents are eq...

toVisibleWhitespaceString()

anyOf()

Create a new HeaderIdGenerator for the specified resolver context.

HtmlIdGeneratorFactory

interface HeaderIdGeneratorFactory

Factory for instantiating an HTML id generator

generateIds()

interface HtmlIdGenerator

NodeCollectingVisitor()

class NodeCollectingVisitor

DataKeyBase

class NullableDataKey

MergeLinkResolver()

LinkResolver

class MergeLinkResolver

Get the current rendering context {@link DataHolder}. These are the options passed o...

getOptions()

interface LinkResolverBasicContext

removePrefix()

TrackedOffsetList()

getOffset()

class TrackedOffset

Tracked Offset information NOTE: purposefully equals compares the offset only and wi...

segOf()

class Seg

Representation of a segment part in a segment list for a sequence it is a Range, eit...

build()

SegmentTree

class SegmentOffsetTree

Segment tree which uses offsets instead of aggregated length of segments Used to fin...

Create a based offset tracker for the given sequence

class BasedOffsetTracker

Build binary tree search data Index data has aggregated lengths with BASE and TE...

class SegmentTree

Binary search tree of sequence segments

SegmentOffsetTree()

getSegType()

abstract class Segment

SegmentedSequence Segment stored in byte[] in serialized format

Return length of text or if text is null span of range

getSegStart()

length()

class SegmentTree.SegmentTreeData

Test segment type being from original sequence

isBase()

isAnchor()

Test segment type being from original sequence

Returns a composed predicate that represents a short-circuiting logical OR of this p...

indexOf()

HeaderIdGenerator()

HtmlIdGenerator...

class HeaderIdGenerator

class SubClassingBag

TranslationContext

interface TranslationHandler

pushPrefix()

setPrefix()

AstHandler

class NodeFormattingHandler

popPrefix()

Render the specified node.

renderDocument()

FormatControlProcessor()

class FormatControlProcessor

initializeFrom()

processFormatControl()

LineAppendable

class LineAppendableImpl

AstAction

interface NodeFormattingHandler.CustomNodeFormatter

Pop a prefix from the stack and set the current prefix

popPrefix()

Pop a prefix from the stack and set the current prefix

popPrefix()

isTrailingBlankLine()

interface ISequenceBuilder

appendImpl()

rawIndentsOnFirstEol()

Returns text range if EOL was appended NOTE: if range == Range.NULL then no line...

append()

getRangePrefixAfterEol()

getFirst()

isNull()

class Range

Get a portion of this sequence selected by range

class LineInfo

Line information in LineAppendable

Returns a predicate that represents the logical negation of this predicate.

external

class? Runnable

isTrimTrailingWhitespace()

combinedPrefix()

isPrefixed()

countTrailingSpaceTab()

Pair()

any()

class BitFieldSet

Re-Implementation of RegularEnumSet class for EnumSet, for "regular sized" enum type...

append lines to appendable with given maximum trailing blank lines and given prefix ...

toSequence()

Construct sequence from this builder using another based sequence which is character...

toSequence()

SequenceBuilder()

Construct a base sequence builder for given base sequence with specific options. ...

Count leading/trailing characters of this sequence Parameters can be CharPredica...

countLeading()

BasedSequenceImpl...

abstract class SegmentedSequence

A BasedSequence which consists of segments of other BasedSequences

Options test for options for this sequence default reports true for global defau...

compare()

getSingleBasedSequence()

interface BasedOptionsHolder

Implemented by BasedOptionsSequence, use instance of it to pass to BasedSequence#of(...

getSegmentBuilder()

Base Constructor

SegmentedSequence

class SegmentedSequenceFull

A BasedSequence which consists of segments of other BasedSequences NOTE: very effici...

Base Constructor

SegmentedSequence

class SegmentedSequenceTree

A BasedSequence which consists of segments of other BasedSequences NOTE: very effici...

getBaseSubSequenceRange()

ISegmentBuilder

class SegmentBuilderBase

Get the base sequence for the text

length()

interface ISegmentBuilder

Options holder, default has none, only available on BasedSequenceWithOptions

noAnchorsSize()

addStats()

class SegmentedSequenceStats

Return iterator over segments

SegmentedSequenceFull()

StatsEntry()

class SegmentedSequenceStats.StatsEntry

class MinMaxAvgLong

SegmentedSequenceTree()

SegmentTree()

emptyBuilder()

SegmentBuilderBase...

class BasedSegmentBuilder

emptyBuilder()

BasedSegmentBuilder()

CharRecoveryOptimizer()

SegmentOptimizer

class CharRecoveryOptimizer

Get builder used for accumulation

BasedSegmentBuilder()

Get the number of lines appended, not including any unterminated ones

getLineCount()

Full line iterator with line info NOTE: will issue line() to terminate any unter...

getLinesInfo()

getLine()

getTrackedOffsets()

Create a based offset tracker for the given sequence

Safe, if index out of range returns '\0'

isCharAt()

getOffsetInfo()

Return the range of indices in the sequence of this based offset tracker that corres...

findSegmentByOffset()

class OffsetInfo

Segment

class Segment.Base

Text()

Segment

class Segment.Text

Segment.TextCharSequenceBase

class Segment.TextCharSequence

TextAsciiCharSequence()

Segment.TextCharSequenceBase

class Segment.TextAsciiCharSequence