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

public Class AsideBlockParser

extends AbstractBlockParser
Class Inheritance
Imports
com.vladsch.flexmark.ast.ListItem, com.vladsch.flexmark.ast.util.Parsing, com.vladsch.flexmark.ext.aside.AsideBlock, .AsideExtension, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.parser.block.*, com.vladsch.flexmark.parser.core.*, com.vladsch.flexmark.util.ast.Block, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.misc.CharPredicate, com.vladsch.flexmark.util.sequence.BasedSequence, com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInHandler, .SpecialLeadInStartsWithCharsHandler, org.jetbrains.annotations.NotNull, .Nullable, java.util.Arrays, .HashSet, .Set

Nested and Inner Type Summary

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

Field Summary

Modifier and TypeField and Description
private final boolean
private final AsideBlock
private final boolean
private final boolean
private final boolean
private final boolean
private int
public static final char
private final boolean

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
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 void
pack-priv static boolean
public AsideBlock
public boolean
pack-priv static boolean
isMarker(final ParserState state, final int index, final boolean inParagraph, final boolean inParagraphListItem, final boolean allowLeadingSpace, final boolean interruptsParagraph, final boolean interruptsItemParagraph, final boolean withLeadSpacesInterruptsItemParagraph)

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

Field Detail

allowLeadingSpaceback to summary
private final boolean allowLeadingSpace
blockback to summary
private final AsideBlock block
continueToBlankLineback to summary
private final boolean continueToBlankLine
ignoreBlankLineback to summary
private final boolean ignoreBlankLine
interruptsItemParagraphback to summary
private final boolean interruptsItemParagraph
interruptsParagraphback to summary
private final boolean interruptsParagraph
lastWasBlankLineback to summary
private int lastWasBlankLine
MARKER_CHARback to summary
public static final char MARKER_CHAR
withLeadSpacesInterruptsItemParagraphback to summary
private final boolean withLeadSpacesInterruptsItemParagraph

Constructor Detail

AsideBlockParserback to summary
public AsideBlockParser(DataHolder options, BasedSequence marker)

Method Detail

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
closeBlockback to summary
public void closeBlock(ParserState state)

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

Annotations
@Override
endsWithMarkerback to summary
pack-priv static boolean endsWithMarker(BasedSequence line)
getBlockback to summary
public AsideBlock getBlock()

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

Returns:AsideBlock

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

the block parser's block node instance

Annotations
@Override
isContainerback to summary
public boolean isContainer()

Overrides com.vladsch.flexmark.parser.block.AbstractBlockParser.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
isMarkerback to summary
pack-priv static boolean isMarker(final ParserState state, final int index, final boolean inParagraph, final boolean inParagraphListItem, final boolean allowLeadingSpace, final boolean interruptsParagraph, final boolean interruptsItemParagraph, final boolean withLeadSpacesInterruptsItemParagraph)
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.aside.internal back to summary

pack-priv Class AsideBlockParser.AsideLeadInHandler

extends Object
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.aside.internal.AsideBlockParser.AsideLeadInHandler

Field Summary

Modifier and TypeField and Description
pack-priv static final SpecialLeadInHandler

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

HANDLERback to summary
pack-priv static final SpecialLeadInHandler HANDLER

Constructor Detail

AsideLeadInHandlerback to summary
pack-priv AsideLeadInHandler()
com.vladsch.flexmark.ext.aside.internal back to summary

private Class AsideBlockParser.BlockFactory

extends AbstractBlockParserFactory
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final boolean
private final boolean
private final boolean
private final boolean

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public BlockStart

Field Detail

allowLeadingSpaceback to summary
private final boolean allowLeadingSpace
interruptsItemParagraphback to summary
private final boolean interruptsItemParagraph
interruptsParagraphback to summary
private final boolean interruptsParagraph
withLeadSpacesInterruptsItemParagraphback to summary
private final boolean withLeadSpacesInterruptsItemParagraph

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.

com.vladsch.flexmark.ext.aside.internal back to summary

public Class AsideBlockParser.Factory

extends Object
implements CustomBlockParserFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.aside.internal.AsideBlockParser.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

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<?>>
public @Nullable SpecialLeadInHandler
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
@SuppressWarnings:UnnecessaryLocalVariable
@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
getLeadInHandlerback to summary
public @Nullable SpecialLeadInHandler getLeadInHandler(@NotNull DataHolder options)
Annotations
@Override
@Nullable