Top Fields Constructors Methods
com.vladsch.flexmark.parser.block

public abstract Class AbstractBlockParser

extends Object
implements BlockParser
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.parser.block.BlockParser
Known Direct Subclasses
com.vladsch.flexmark.parser.core.BlockQuoteParser, com.vladsch.flexmark.parser.core.DocumentBlockParser, com.vladsch.flexmark.parser.core.FencedCodeBlockParser, com.vladsch.flexmark.parser.core.HeadingParser, com.vladsch.flexmark.parser.core.HtmlBlockParser, com.vladsch.flexmark.parser.core.IndentedCodeBlockParser, com.vladsch.flexmark.parser.core.ListBlockParser, com.vladsch.flexmark.parser.core.ListItemParser, com.vladsch.flexmark.parser.core.ParagraphParser, com.vladsch.flexmark.parser.core.ThematicBreakParser
Imports
com.vladsch.flexmark.parser.InlineParser, com.vladsch.flexmark.util.ast.BlankLine, .Block, .BlockContent, .Node, com.vladsch.flexmark.util.data.MutableDataHolder, .MutableDataSet, com.vladsch.flexmark.util.sequence.BasedSequence

Field Summary

Modifier and TypeField and Description
private boolean
isClosed

private MutableDataSet
mutableData

Constructor Summary

AccessConstructor and Description
public
AbstractBlockParser()

Method Summary

Modifier and TypeMethod and Description
public void
addLine(ParserState
parser state
state, BasedSequence
line sequence
line)

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

Add another line to the block

public boolean
breakOutOnDoubleBlankLine()

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

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)

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

public boolean
canInterruptBy(BlockParserFactory
interrupting block parser
blockParserFactory)

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

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

public final void
finalizeClosedBlock()

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

Used to clean up and prepare for the next parsing run of the AbstractBlockParser for internal parser house keeping not for BlockParser implementors

public BlockContent
getBlockContent()

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

public MutableDataHolder
getDataHolder()

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

public boolean
isClosed()

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

public boolean
isContainer()

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

public boolean
isInterruptible()

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

Allows block parsers to be interrupted by other block parsers

public boolean
isParagraphParser()

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

public boolean

Returns:

true if the blank line should be propagated to parent
isPropagatingLastBlankLine(BlockParser
the last matched block parser instance
lastMatchedBlockParser)

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

should be overridden in BlockQuote, FencedCode and ListItem

public boolean
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 void
parseInlines(InlineParser
instance of inline parser
inlineParser)

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

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

public void
removeBlankLines()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

isClosedback to summary
private boolean isClosed
mutableDataback to summary
private MutableDataSet mutableData

Constructor Detail

AbstractBlockParserback to summary
public AbstractBlockParser()

Method Detail

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

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
breakOutOnDoubleBlankLineback to summary
public boolean breakOutOnDoubleBlankLine()

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

Returns:boolean

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

true if Double blank line should finalize this block parser and its children and reset to parent

Annotations
@Override
canContainback to summary
public boolean canContain(ParserState state, BlockParser blockParser, Block block)

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)

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
finalizeClosedBlockback to summary
public final void finalizeClosedBlock()

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

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

Used to clean up and prepare for the next parsing run of the AbstractBlockParser for internal parser house keeping not for BlockParser implementors

Annotations
@Override
getBlockContentback to summary
public BlockContent getBlockContent()

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

Returns:BlockContent

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

get the currently accumulated block content. May or may not be implemented by any parser except for the ParagraphParser or one that returns true for isParagraphParser()

Annotations
@Override
getDataHolderback to summary
public MutableDataHolder getDataHolder()

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

Returns:MutableDataHolder

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

the data holder for a block parser instance. Implemented by AbstractBlockParser

Annotations
@Override
isClosedback to summary
public boolean isClosed()

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

Returns:boolean

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

true if the block is already closed.

Annotations
@Override
isContainerback to summary
public boolean isContainer()

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

Returns:boolean

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

true if the block that is parsed is a container (contains other blocks), or false if it's a leaf.

Annotations
@Override
isInterruptibleback to summary
public boolean 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
isParagraphParserback to summary
public boolean isParagraphParser()

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

Returns:boolean

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

true if this block parser is the paragraph block parser

Annotations
@Override
isPropagatingLastBlankLineback to summary
public boolean isPropagatingLastBlankLine(BlockParser lastMatchedBlockParser)

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

should be overridden in BlockQuote, FencedCode and ListItem

Parameters
lastMatchedBlockParser:BlockParser

the last matched block parser instance

Returns:boolean

true if the blank line should be propagated to parent

Annotations
@Override
isRawTextback to summary
public boolean 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
parseInlinesback to summary
public void parseInlines(InlineParser inlineParser)

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
removeBlankLinesback to summary
public void removeBlankLines()