Class FootnoteBlockParser

java.lang.Object

com.vladsch.flexmark.parser.block.AbstractBlockParser

com.vladsch.flexmark.ext.footnotes.internal.FootnoteBlockParser

All Implemented Interfaces:

BlockParser

public class FootnoteBlockParser
extends AbstractBlockParser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FootnoteBlockParser.BlockFactory
static class	FootnoteBlockParser.Factory

Field Summary

Fields

Modifier and Type	Field	Description
private final FootnoteBlock	block
private BlockContent	content
private final int	contentOffset
(package private) static Pattern	FOOTNOTE_DEF_PATTERN
(package private) static String	FOOTNOTE_ID
(package private) static Pattern	FOOTNOTE_ID_PATTERN
private final FootnoteOptions	options

Constructor Summary

Constructors

Constructor	Description
FootnoteBlockParser(FootnoteOptions options, int contentOffset)

Method Summary

Modifier and Type	Method	Description
void	addLine(ParserState state, BasedSequence line)	Add another line to the block
boolean	canContain(ParserState state, BlockParser blockParser, Block block)
void	closeBlock(ParserState state)
Block	getBlock()
BlockContent	getBlockContent()
boolean	isContainer()
BlockContinue	tryContinue(ParserState state)	See if the block parser can continue parsing the current block

Methods inherited from class AbstractBlockParser

breakOutOnDoubleBlankLine, canInterruptBy, finalizeClosedBlock, getDataHolder, isClosed, isInterruptible, isParagraphParser, isPropagatingLastBlankLine, isRawText, parseInlines, removeBlankLines

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FOOTNOTE_ID

static String FOOTNOTE_ID

FOOTNOTE_ID_PATTERN

static Pattern FOOTNOTE_ID_PATTERN

FOOTNOTE_DEF_PATTERN

static Pattern FOOTNOTE_DEF_PATTERN

block

private final FootnoteBlock block

options

private final FootnoteOptions options

contentOffset

private final int contentOffset

content

private BlockContent content

Constructor Details

FootnoteBlockParser

public FootnoteBlockParser(FootnoteOptions options,
 int contentOffset)

Method Details

getBlockContent

public BlockContent getBlockContent()

Specified by:

getBlockContent in interface BlockParser

Overrides:

getBlockContent in class AbstractBlockParser

Returns:

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 BlockParser.isParagraphParser()

getBlock

public Block getBlock()

Returns:

the block parser's block node instance

tryContinue

public BlockContinue tryContinue(ParserState state)

Description copied from interface: BlockParser

See if the block parser can continue parsing the current block

Parameters:

state - current parsing state

Returns:

block continue instance

addLine

public void addLine(ParserState state,
 BasedSequence line)

Description copied from interface: BlockParser

Add another line to the block

Specified by:

addLine in interface BlockParser

Overrides:

addLine in class AbstractBlockParser

Parameters:

state - parser state

line - line sequence

closeBlock

public void closeBlock(ParserState state)

isContainer

public boolean isContainer()

Specified by:

isContainer in interface BlockParser

Overrides:

isContainer in class AbstractBlockParser

Returns:

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

canContain

public boolean canContain(ParserState state,
 BlockParser blockParser,
 Block block)

Specified by:

canContain in interface BlockParser

Overrides:

canContain in class AbstractBlockParser

Parameters:

state - parser state

blockParser - block parser

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