Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.toc.internal

public Class TocBlockParser

extends AbstractBlockParser
Class Inheritance
Imports
com.vladsch.flexmark.ast.util.Parsing, com.vladsch.flexmark.ext.toc.TocBlock, com.vladsch.flexmark.parser.InlineParser, com.vladsch.flexmark.parser.block.*, com.vladsch.flexmark.util.ast.Block, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.util.Set, java.util.regex.Matcher, .Pattern

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
public static class
pack-priv static class

Field Summary

Modifier and TypeField and Description
private final TocBlock

Constructor Summary

AccessConstructor and Description
pack-priv
TocBlockParser(DataHolder options, BasedSequence tocChars, BasedSequence styleChars)

Method Summary

Modifier and TypeMethod and Description
public void
public void
public Block
public void
parseInlines(InlineParser
instance of inline parser
inlineParser
)

Overrides com.vladsch.flexmark.parser.block.AbstractBlockParser.parseInlines.

Implements com.vladsch.flexmark.parser.block.BlockParser.parseInlines.

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

public BlockContinue
tryContinue(ParserState
current parsing state
state
)

Implements com.vladsch.flexmark.parser.block.BlockParser.tryContinue.

See if the block parser can continue parsing the current block

Inherited from com.vladsch.flexmark.parser.block.AbstractBlockParser:
breakOutOnDoubleBlankLinecanContaincanInterruptByfinalizeClosedBlockgetBlockContentgetDataHolderisClosedisContainerisInterruptibleisParagraphParserisPropagatingLastBlankLineisRawTextremoveBlankLines

Field Detail

blockback to summary
private final TocBlock block

Constructor Detail

TocBlockParserback to summary
pack-priv TocBlockParser(DataHolder options, BasedSequence tocChars, BasedSequence styleChars)

Method Detail

addLineback to summary
public void addLine(ParserState state, BasedSequence line)

Overrides com.vladsch.flexmark.parser.block.AbstractBlockParser.addLine.

Implements com.vladsch.flexmark.parser.block.BlockParser.addLine.

Doc from com.vladsch.flexmark.parser.block.BlockParser.addLine.

Add another line to the block

Parameters
state:ParserState

parser state

line:BasedSequence

line sequence

Annotations
@Override
closeBlockback to summary
public void closeBlock(ParserState state)

Implements com.vladsch.flexmark.parser.block.BlockParser.closeBlock.

Annotations
@Override
getBlockback to summary
public Block getBlock()

Implements com.vladsch.flexmark.parser.block.BlockParser.getBlock.

Returns:Block

Doc from com.vladsch.flexmark.parser.block.BlockParser.getBlock.

the block parser's block node instance

Annotations
@Override
parseInlinesback to summary
public void parseInlines(InlineParser inlineParser)

Overrides com.vladsch.flexmark.parser.block.AbstractBlockParser.parseInlines.

Implements com.vladsch.flexmark.parser.block.BlockParser.parseInlines.

Doc from com.vladsch.flexmark.parser.block.BlockParser.parseInlines.

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

Parameters
inlineParser:InlineParser

instance of inline parser

Annotations
@Override
tryContinueback to summary
public BlockContinue tryContinue(ParserState state)

Implements com.vladsch.flexmark.parser.block.BlockParser.tryContinue.

Doc from com.vladsch.flexmark.parser.block.BlockParser.tryContinue.

See if the block parser can continue parsing the current block

Parameters
state:ParserState

current parsing state

Returns:BlockContinue

block continue instance

Annotations
@Override
com.vladsch.flexmark.ext.toc.internal back to summary

private Class TocBlockParser.BlockFactory

extends AbstractBlockParserFactory
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final TocBlockParser.TocParsing

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public BlockStart

Field Detail

myParsingback to summary
private final TocBlockParser.TocParsing myParsing

Constructor Detail

BlockFactoryback to summary
pack-priv BlockFactory(DataHolder options)

Method Detail

tryStartback to summary
public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockParser)

Implements com.vladsch.flexmark.parser.block.BlockParserFactory.tryStart.

Annotations
@Override
com.vladsch.flexmark.ext.toc.internal back to summary

public Class TocBlockParser.Factory

extends Object
implements CustomBlockParserFactory
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.parser.block.CustomBlockParserFactory, com.vladsch.flexmark.util.dependency.Dependent, java.util.function.Function

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
public @NotNull BlockParserFactory
apply(@NotNull DataHolder
the function argument
options
)

Implements java.util.function.Function.apply.

Applies this function to the given argument.

public @Nullable Set<Class<?>>
public @Nullable Set<Class<?>>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

affectsGlobalScopeback to summary
public boolean affectsGlobalScope()

Implements com.vladsch.flexmark.util.dependency.Dependent.affectsGlobalScope.

Returns:boolean

Doc from com.vladsch.flexmark.util.dependency.Dependent.affectsGlobalScope.

true if this dependent affects the global scope, which means that any that depend on it have to be run after this dependent has run against all elements. Otherwise, the dependent can run on an element after its dependents have processed an element. parsed.

Annotations
@Override
applyback to summary
public @NotNull BlockParserFactory apply(@NotNull DataHolder options)

Implements java.util.function.Function.apply.

Doc from java.util.function.Function.apply.

Applies this function to the given argument.

Parameters
options:@NotNull DataHolder

the function argument

Returns:@NotNull BlockParserFactory

the function result

Annotations
@NotNull
@Override
getAfterDependentsback to summary
public @Nullable Set<Class<?>> getAfterDependents()

Implements com.vladsch.flexmark.util.dependency.Dependent.getAfterDependents.

Returns:@Nullable Set<Class<?>>

Doc from com.vladsch.flexmark.util.dependency.Dependent.getAfterDependents.

null or a list of dependents that must be executed before calling this one if any of the blocks in the list affect global state then these will be run on ALL blocks of the document before this preprocessor is called.

Annotations
@Nullable
@Override
getBeforeDependentsback to summary
public @Nullable Set<Class<?>> getBeforeDependents()

Implements com.vladsch.flexmark.util.dependency.Dependent.getBeforeDependents.

Returns:@Nullable Set<Class<?>>

Doc from com.vladsch.flexmark.util.dependency.Dependent.getBeforeDependents.

null or a list of dependents that must be executed after calling this one if any of the blocks in the list affect global state then these will be run on ALL blocks of the document before this preprocessor is called.

Annotations
@Nullable
@Override
com.vladsch.flexmark.ext.toc.internal back to summary

pack-priv Class TocBlockParser.TocParsing

extends Parsing
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final Pattern
Inherited from com.vladsch.flexmark.ast.util.Parsing:
ADDITIONAL_CHARSallowNameSpaceASCII_CLOSE_PUNCTUATIONASCII_OPEN_PUNCTUATIONASCII_PUNCTUATIONATTRIBUTEATTRIBUTENAMEATTRIBUTEVALUEATTRIBUTEVALUESPECAUTOLINKCDATACLOSETAGCODE_BLOCK_INDENTDECLARATIONDOUBLEQUOTEDVALUEEMAIL_AUTOLINKENTITYENTITY_HEREEOLESCAPABLEESCAPED_CHAREXCLUDED_0_TO_SPACEFINAL_SPACEHTML_TAGHTMLCOMMENThtmlForTranslatorHTMLTAGIN_BRACES_W_SPIN_MATCHED_PARENS_NOSPIN_MATCHED_PARENS_W_SPIN_PARENS_NOSPIN_PARENS_W_SPINTELLIJ_DUMMY_IDENTIFIERINTELLIJ_DUMMY_IDENTIFIER_CHARintellijDummyIdentifieritemPrefixCharsLINE_ENDLINK_DESTINATIONLINK_DESTINATION_ANGLESLINK_DESTINATION_MATCHED_PARENSLINK_DESTINATION_MATCHED_PARENS_NOSPLINK_LABELLINK_TITLELINK_TITLE_STRINGLIST_ITEM_MARKERlistsItemMarkerSpacelistsOrderedItemDotOnlyOPENTAGoptionsparseJekyllMacroInLinkUrlPROCESSINGINSTRUCTIONPUNCTUATIONPUNCTUATION_CLOSEPUNCTUATION_CLOSE_ONLYPUNCTUATION_ONLYPUNCTUATION_OPENPUNCTUATION_OPEN_ONLYREG_CHARREG_CHAR_PARENSREG_CHAR_SPREG_CHAR_SP_PARENSREST_OF_LINESINGLEQUOTEDVALUESPspaceInLinkUrlSPNISPNLSPNL_URLST_CDATAST_DOUBLEQUOTEDVALUEST_HTMLCOMMENTST_PROCESSINGINSTRUCTIONST_SINGLEQUOTEDVALUETAGNAMETICKSTICKS_HEREtranslationAutolinkTagPatterntranslationHtmlInlineTagPatternUNICODE_WHITESPACE_CHARUNQUOTEDVALUEWHITESPACEWWW_AUTOLINKXML_NAMESPACEXML_NAMESPACE_CHARXML_NAMESPACE_START

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from com.vladsch.flexmark.ast.util.Parsing:
ADDITIONAL_CHARSADDITIONAL_CHARS_SETcolumnsToNextTabStopEXCLUDED_0_TO_SPACEfindLineBreakisBlankisLetterisSpaceOrTab

Field Detail

TOC_BLOCK_STARTback to summary
pack-priv final Pattern TOC_BLOCK_START

Constructor Detail

TocParsingback to summary
public TocParsing(DataHolder options)