Class YamlFrontMatterExtension

java.lang.Object

com.vladsch.flexmark.ext.yaml.front.matter.YamlFrontMatterExtension

All Implemented Interfaces:

Formatter.FormatterExtension, Parser.ParserExtension, Extension

public class YamlFrontMatterExtension
extends Object
implements Parser.ParserExtension, Formatter.FormatterExtension

Extension for YAML-like metadata.

Create it with create() and then configure it on the builders

The parsed metadata is turned into YamlFrontMatterNode. You can access the metadata using AbstractYamlFrontMatterVisitor.

Field Summary

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	YamlFrontMatterExtension()

Method Summary

Modifier and Type	Method	Description
static YamlFrontMatterExtension	create()
void	extend(Formatter.Builder formatterBuilder)
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	parserOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
void	rendererOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options.

Methods inherited from class Object

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

Constructor Details

YamlFrontMatterExtension

private YamlFrontMatterExtension()

Method Details

rendererOptions

public void rendererOptions(MutableDataHolder options)

Description copied from interface: Formatter.FormatterExtension

This method is called first on all extensions so that they can adjust the options.

Specified by:

rendererOptions in interface Formatter.FormatterExtension

Parameters:

options - option set that will be used for the builder

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.FormatterExtension

extend

public void extend(Parser.Builder parserBuilder)

Description copied from interface: Parser.ParserExtension

This method is called on all extensions so that they can register their custom processors

Specified by:

extend in interface Parser.ParserExtension

Parameters:

parserBuilder - parser builder with which to register extensions

See Also:

• Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
• Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
• Parser.Builder.customInlineParserFactory(InlineParserFactory)
• Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
• Parser.Builder.postProcessorFactory(PostProcessorFactory)
• Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
• Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
• Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
• Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)

parserOptions

public void parserOptions(MutableDataHolder options)

Description copied from interface: Parser.ParserExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

parserOptions in interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

create

public static YamlFrontMatterExtension create()