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

public Class AdmonitionBlockParser

extends AbstractBlockParser
Class Inheritance
Imports
com.vladsch.flexmark.ast.ListItem, com.vladsch.flexmark.ast.util.Parsing, com.vladsch.flexmark.ext.admonition.AdmonitionBlock, com.vladsch.flexmark.parser.block.*, com.vladsch.flexmark.util.ast.Block, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInHandler, org.jetbrains.annotations.NotNull, .Nullable, java.util.Set, java.util.function.Consumer, java.util.regex.Matcher, .Pattern

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 static final String
pack-priv final AdmonitionBlock
private final int
private boolean
private final AdmonitionOptions

Constructor Summary

AccessConstructor and Description
pack-priv
AdmonitionBlockParser(AdmonitionOptions options, int contentIndent)

Method Summary

Modifier and TypeMethod and Description
public boolean
canContain(ParserState
parser state
state
,
BlockParser
block parser
blockParser
,
final 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
public Block
private int
public boolean
pack-priv static boolean
isMarker(final ParserState state, final int index, final boolean inParagraph, final boolean inParagraphListItem, final AdmonitionOptions options)

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

Field Detail

ADMONITION_START_FORMATback to summary
private static final String ADMONITION_START_FORMAT
blockback to summary
pack-priv final AdmonitionBlock block
contentIndentback to summary
private final int contentIndent
hadBlankLineback to summary
private boolean hadBlankLine
optionsback to summary
private final AdmonitionOptions options

Constructor Detail

AdmonitionBlockParserback to summary
pack-priv AdmonitionBlockParser(AdmonitionOptions options, int contentIndent)

Method Detail

canContainback to summary
public boolean canContain(ParserState state, BlockParser blockParser, final 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
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
getContentIndentback to summary
private int getContentIndent()
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 AdmonitionOptions options)
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.admonition.internal back to summary

pack-priv Class AdmonitionBlockParser.AdmonitionLeadInHandler

extends Object
implements SpecialLeadInHandler
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.admonition.internal.AdmonitionBlockParser.AdmonitionLeadInHandler
All Implemented Interfaces
com.vladsch.flexmark.util.sequence.mappers.SpecialLeadInHandler

Field Summary

Modifier and TypeField and Description
pack-priv static final SpecialLeadInHandler

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

HANDLERback to summary
pack-priv static final SpecialLeadInHandler HANDLER

Constructor Detail

AdmonitionLeadInHandlerback to summary
pack-priv AdmonitionLeadInHandler()

Method Detail

escapeback to summary
public boolean escape(@NotNull BasedSequence sequence, @Nullable DataHolder options, @NotNull Consumer<CharSequence> consumer)
Annotations
@Override
unEscapeback to summary
public boolean unEscape(@NotNull BasedSequence sequence, @Nullable DataHolder options, @NotNull Consumer<CharSequence> consumer)
Annotations
@Override
com.vladsch.flexmark.ext.admonition.internal back to summary

private Class AdmonitionBlockParser.BlockFactory

extends AbstractBlockParserFactory
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final AdmonitionOptions

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public BlockStart

Field Detail

optionsback to summary
private final AdmonitionOptions options

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

public Class AdmonitionBlockParser.Factory

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