Top Inners Fields Constructors Methods
com.vladsch.flexmark.ext.yaml.front.matter.internal

public Class YamlFrontMatterBlockParser

extends AbstractBlockParser
Class Inheritance
Imports
com.vladsch.flexmark.ext.yaml.front.matter.YamlFrontMatterBlock, .YamlFrontMatterNode, com.vladsch.flexmark.parser.InlineParser, com.vladsch.flexmark.parser.block.*, com.vladsch.flexmark.parser.core.DocumentBlockParser, com.vladsch.flexmark.util.ast.Block, .BlockContent, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, .PrefixedSubSequence, .SegmentedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.util.ArrayList, .List, .Set, java.util.regex.Matcher, .Pattern

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
YamlFrontMatterBlockParser.BlockFactory

public static class
YamlFrontMatterBlockParser.Factory

Field Summary

Modifier and TypeField and Description
private YamlFrontMatterBlock
block

private BlockContent
content

private BasedSequence
currentKey

private List<BasedSequence>
currentValues

private boolean
inLiteral

private boolean
inYAMLBlock

private static final Pattern
REGEX_BEGIN

private static final Pattern
REGEX_END

private static final Pattern
REGEX_METADATA

private static final Pattern
REGEX_METADATA_LIST

private static final Pattern
REGEX_METADATA_LITERAL

Constructor Summary

AccessConstructor and Description
public
YamlFrontMatterBlockParser()

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
isContainer()

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

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

public void
parseInlines(InlineParser
instance of inline parser
inlineParser)

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

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

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

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

Field Detail

blockback to summary
private YamlFrontMatterBlock block
contentback to summary
private BlockContent content
currentKeyback to summary
private BasedSequence currentKey
currentValuesback to summary
private List<BasedSequence> currentValues
inLiteralback to summary
private boolean inLiteral
inYAMLBlockback to summary
private boolean inYAMLBlock
REGEX_BEGINback to summary
private static final Pattern REGEX_BEGIN
REGEX_ENDback to summary
private static final Pattern REGEX_END
REGEX_METADATAback to summary
private static final Pattern REGEX_METADATA
REGEX_METADATA_LISTback to summary
private static final Pattern REGEX_METADATA_LIST
REGEX_METADATA_LITERALback to summary
private static final Pattern REGEX_METADATA_LITERAL

Constructor Detail

YamlFrontMatterBlockParserback to summary
public YamlFrontMatterBlockParser()

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
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
parseInlinesback to summary
public void parseInlines(InlineParser inlineParser)

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

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
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.yaml.front.matter.internal back to summary

private Class YamlFrontMatterBlockParser.BlockFactory

extends AbstractBlockParserFactory
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
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.

Constructor Detail

BlockFactoryback to summary
private 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.yaml.front.matter.internal back to summary

public Class YamlFrontMatterBlockParser.Factory

extends Object
implements CustomBlockParserFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.yaml.front.matter.internal.YamlFrontMatterBlockParser.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