Top Inners Fields Constructors Methods
com.vladsch.flexmark.parser.core

public Class HtmlBlockParser

extends AbstractBlockParser
Class Inheritance
Imports
com.vladsch.flexmark.ast.*, com.vladsch.flexmark.ast.util.Parsing, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.parser.block.*, com.vladsch.flexmark.parser.internal.HtmlDeepParser, com.vladsch.flexmark.util.ast.Block, .BlockContent, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.util.Arrays, .HashSet, .Set, java.util.regex.Matcher, .Pattern

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
public static class
private static class

Field Summary

Modifier and TypeField and Description
private final HtmlBlockBase
private final Pattern
private BlockContent
private final HtmlDeepParser
private boolean
public static final String
public static final String
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean

Constructor Summary

AccessConstructor and Description
pack-priv
HtmlBlockParser(DataHolder options, Pattern closingPattern, boolean isComment, HtmlDeepParser deepParser)

Method Summary

Modifier and TypeMethod and Description
public void
public boolean
canContain(ParserState
parser state
state
,
BlockParser
block parser
blockParser
,
Block
new block being started @return true if this block parser's block can contain the given block type, false if it cannot
block
)

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

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

public boolean
canInterruptBy(BlockParserFactory
interrupting block parser
blockParserFactory
)

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

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

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

public void
public Block
public boolean
public boolean
isRawText()

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

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

Allows block parsers to keep indenting spaces for those blocks that are interruptible but don't want indenting spaces removed.

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:
breakOutOnDoubleBlankLinefinalizeClosedBlockgetBlockContentgetDataHolderisClosedisContainerisParagraphParserisPropagatingLastBlankLineparseInlinesremoveBlankLines

Field Detail

blockback to summary
private final HtmlBlockBase block
closingPatternback to summary
private final Pattern closingPattern
contentback to summary
private BlockContent content
deepParserback to summary
private final HtmlDeepParser deepParser
finishedback to summary
private boolean finished
HTML_COMMENT_CLOSEback to summary
public static final String HTML_COMMENT_CLOSE
HTML_COMMENT_OPENback to summary
public static final String HTML_COMMENT_OPEN
myHtmlBlockDeepParseBlankLineInterruptsback to summary
private final boolean myHtmlBlockDeepParseBlankLineInterrupts
myHtmlBlockDeepParseBlankLineInterruptsPartialTagback to summary
private final boolean myHtmlBlockDeepParseBlankLineInterruptsPartialTag
myHtmlBlockDeepParseIndentedCodeInterruptsback to summary
private final boolean myHtmlBlockDeepParseIndentedCodeInterrupts
myHtmlBlockDeepParseMarkdownInterruptsClosedback to summary
private final boolean myHtmlBlockDeepParseMarkdownInterruptsClosed
myHtmlBlockDeepParseNonBlockback to summary
private final boolean myHtmlBlockDeepParseNonBlock
parseInnerHtmlCommentsback to summary
private final boolean parseInnerHtmlComments

Constructor Detail

HtmlBlockParserback to summary
pack-priv HtmlBlockParser(DataHolder options, Pattern closingPattern, boolean isComment, HtmlDeepParser deepParser)

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
canContainback to summary
public boolean canContain(ParserState state, BlockParser blockParser, Block block)

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

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

Parameters
state:ParserState

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

parser state

blockParser:BlockParser

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

block parser

block:Block

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

new block being started @return true if this block parser's block can contain the given block type, false if it cannot

Annotations
@Override
canInterruptByback to summary
public boolean canInterruptBy(BlockParserFactory blockParserFactory)

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

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

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

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

Parameters
blockParserFactory:BlockParserFactory

interrupting block parser

Returns:boolean

true if can interrupt.

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
isInterruptibleback to summary
public boolean isInterruptible()

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

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

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

Allows block parsers to be interrupted by other block parsers

Returns:boolean

true if block starts should be tried when this block parser is active

Annotations
@Override
isRawTextback to summary
public boolean isRawText()

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

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

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

Allows block parsers to keep indenting spaces for those blocks that are interruptible but don't want indenting spaces removed.

Returns:boolean

true if block wants to keep indenting spaces

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.parser.core back to summary

private Class HtmlBlockParser.BlockFactory

extends AbstractBlockParserFactory
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private HtmlBlockParser.Patterns

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public BlockStart

Field Detail

myHtmlBlockCommentOnlyFullLineback to summary
private final boolean myHtmlBlockCommentOnlyFullLine
myHtmlBlockDeepParseFirstOpenTagOnOneLineback to summary
private final boolean myHtmlBlockDeepParseFirstOpenTagOnOneLine
myHtmlBlockDeepParseNonBlockback to summary
private final boolean myHtmlBlockDeepParseNonBlock
myHtmlBlockDeepParserback to summary
private final boolean myHtmlBlockDeepParser
myHtmlBlockStartOnlyOnBlockTagsback to summary
private final boolean myHtmlBlockStartOnlyOnBlockTags
myHtmlCommentBlocksInterruptParagraphback to summary
private final boolean myHtmlCommentBlocksInterruptParagraph
myPatternsback to summary
private HtmlBlockParser.Patterns myPatterns

Constructor Detail

BlockFactoryback to summary
private 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.parser.core back to summary

public Class HtmlBlockParser.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.parser.core back to summary

private Class HtmlBlockParser.Patterns

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public final Pattern[][]
public final int

Constructor Summary

AccessConstructor and Description
public
Patterns(Parsing parsing, DataHolder options)

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

BLOCK_PATTERNSback to summary
public final Pattern[][] BLOCK_PATTERNS
COMMENT_PATTERN_INDEXback to summary
public final int COMMENT_PATTERN_INDEX

Constructor Detail

Patternsback to summary
public Patterns(Parsing parsing, DataHolder options)