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 java.lang.Object implements Parser.ParserExtension, Formatter.FormatterExtension
Extension for YAML-like metadata.Create it with
create()
and then configure it on the buildersThe parsed metadata is turned into
YamlFrontMatterNode
. You can access the metadata usingAbstractYamlFrontMatterVisitor
.
-
-
Field Summary
-
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 processorsvoid
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.
-
-
-
Method Detail
-
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 interfaceFormatter.FormatterExtension
- Parameters:
options
- option set that will be used for the builder
-
extend
public void extend(Formatter.Builder formatterBuilder)
- Specified by:
extend
in interfaceFormatter.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 interfaceParser.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 interfaceParser.ParserExtension
- Parameters:
options
- option set that will be used for the builder
-
create
public static YamlFrontMatterExtension create()
-
-