Class YamlSubsetParser

java.lang.Object

org.commonmark.ext.front.matter.parser.YamlSubsetParser

All Implemented Interfaces:

FrontMatterParser

public class YamlSubsetParser
extends Object
implements FrontMatterParser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlSubsetParser.Factory

Nested classes/interfaces inherited from interface org.commonmark.ext.front.matter.parser.FrontMatterParser

FrontMatterParser.SeparatorRole

Constructor Summary

Constructors

Constructor	Description
YamlSubsetParser()

Method Summary

Modifier and Type	Method	Description
FrontMatterParser.SeparatorRole	onEndingSeparator(YamlFrontMatterBlock block, org.commonmark.parser.SourceLine separator)	Notifies about finding the line with the ending separator (`---` or `...`, without initial whitespace).
void	onNextLine(YamlFrontMatterBlock block, org.commonmark.parser.SourceLine line)

Methods inherited from class java.lang.Object

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

Constructor Details

YamlSubsetParser

public YamlSubsetParser()

Method Details

onNextLine

public void onNextLine(YamlFrontMatterBlock block,
 org.commonmark.parser.SourceLine line)

Specified by:

onNextLine in interface FrontMatterParser

onEndingSeparator

public FrontMatterParser.SeparatorRole onEndingSeparator(YamlFrontMatterBlock block,
 org.commonmark.parser.SourceLine separator)

Description copied from interface: FrontMatterParser

Notifies about finding the line with the ending separator (`---` or `...`, without initial whitespace). Advanced parsers may be able to determine that the separator is a part of the single-/double-quoted multiline string and return FrontMatterParser.SeparatorRole.CONTENT to include it in the front matter content. In this case, front matter parsing continues until finding another separator. To end the parsing, return FrontMatterParser.SeparatorRole.BLOCK_END.

Specified by:

onEndingSeparator in interface FrontMatterParser

Parameters:

block - Main block node

separator - `---` or `...`

Returns:

Separator role: block end or the part of the front matter content