Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.spec.example.internal

public Class SpecExampleBlockParser

extends AbstractBlockParser
Class Inheritance
Imports
com.vladsch.flexmark.ext.spec.example.*, com.vladsch.flexmark.parser.block.*, com.vladsch.flexmark.parser.core.*, com.vladsch.flexmark.util.ast.Block, .BlockContent, .Node, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.misc.CharPredicate, com.vladsch.flexmark.util.sequence.BasedSequence, .SequenceUtils, org.jetbrains.annotations.NotNull, .Nullable, java.util.Arrays, .HashSet, .List, .Set, java.util.regex.Matcher, .Pattern

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
SpecExampleBlockParser.BlockFactory

public static class
SpecExampleBlockParser.Factory

Field Summary

Modifier and TypeField and Description
pack-priv final SpecExampleBlock
block

private BlockContent
content

private static final int
GROUP_COORD_CLOSE

private static final int
GROUP_COORD_OPEN

private static final int
GROUP_NUMBER

private static final int
GROUP_NUMBER_SEPARATOR

private static final int
GROUP_OPTION_KEYWORD

private static final int
GROUP_OPTIONS

private static final int
GROUP_OPTIONS_CLOSE

private static final int
GROUP_OPTIONS_OPEN

private static final int
GROUP_SECTION

private final SpecExampleOptions
myOptions

private static final Pattern
OPTIONS_PATTERN

Constructor Summary

AccessConstructor and Description
public
SpecExampleBlockParser(DataHolder options)

Method Summary

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

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

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

Add another line to the block

public void
closeBlock(ParserState state)

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

public Block
getBlock()

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

public boolean
isPropagatingLastBlankLine(BlockParser
the last matched block parser instance
lastMatchedBlockParser)

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

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

should be overridden in BlockQuote, FencedCode and ListItem

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

Field Detail

blockback to summary
pack-priv final SpecExampleBlock block
contentback to summary
private BlockContent content
GROUP_COORD_CLOSEback to summary
private static final int GROUP_COORD_CLOSE
GROUP_COORD_OPENback to summary
private static final int GROUP_COORD_OPEN
GROUP_NUMBERback to summary
private static final int GROUP_NUMBER
GROUP_NUMBER_SEPARATORback to summary
private static final int GROUP_NUMBER_SEPARATOR
GROUP_OPTION_KEYWORDback to summary
private static final int GROUP_OPTION_KEYWORD
GROUP_OPTIONSback to summary
private static final int GROUP_OPTIONS
GROUP_OPTIONS_CLOSEback to summary
private static final int GROUP_OPTIONS_CLOSE
GROUP_OPTIONS_OPENback to summary
private static final int GROUP_OPTIONS_OPEN
GROUP_SECTIONback to summary
private static final int GROUP_SECTION
myOptionsback to summary
private final SpecExampleOptions myOptions
OPTIONS_PATTERNback to summary
private static final Pattern OPTIONS_PATTERN

Constructor Detail

SpecExampleBlockParserback to summary
public SpecExampleBlockParser(DataHolder options)

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
isPropagatingLastBlankLineback to summary
public boolean isPropagatingLastBlankLine(BlockParser lastMatchedBlockParser)

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

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

Doc from com.vladsch.flexmark.parser.block.AbstractBlockParser.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
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.spec.example.internal back to summary

private Class SpecExampleBlockParser.BlockFactory

extends AbstractBlockParserFactory
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final SpecExampleOptions
myOptions

Constructor Summary

AccessConstructor and Description
pack-priv
BlockFactory(DataHolder options)

Method Summary

Modifier and TypeMethod and Description
public BlockStart
tryStart(ParserState state, MatchedBlockParser matchedBlockParser)

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

Field Detail

myOptionsback to summary
private final SpecExampleOptions myOptions

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.spec.example.internal back to summary

public Class SpecExampleBlockParser.Factory

extends Object
implements CustomBlockParserFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.spec.example.internal.SpecExampleBlockParser.Factory
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
Factory()

Method Summary

Modifier and TypeMethod and Description
public boolean
affectsGlobalScope()

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

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<?>>
getAfterDependents()

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

public @Nullable Set<Class<?>>
getBeforeDependents()

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

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