Class YamlFrontMatterNodeFormatter

java.lang.Object

com.vladsch.flexmark.ext.yaml.front.matter.internal.YamlFrontMatterNodeFormatter

All Implemented Interfaces:

NodeFormatter, PhasedNodeFormatter

public class YamlFrontMatterNodeFormatter
extends Object
implements PhasedNodeFormatter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlFrontMatterNodeFormatter.Factory

Constructor Summary

Constructors

Constructor	Description
YamlFrontMatterNodeFormatter(DataHolder options)

Method Summary

Modifier and Type	Method	Description
@Nullable Set<FormattingPhase>	getFormattingPhases()
@Nullable Set<Class<?>>	getNodeClasses()	Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.
@Nullable Set<NodeFormattingHandler<?>>	getNodeFormattingHandlers()
private void	render(YamlFrontMatterBlock node, NodeFormatterContext context, MarkdownWriter markdown)
void	renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase)	Render the specified node.

Methods inherited from class Object

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

Methods inherited from interface NodeFormatter

getBlockQuoteLikePrefixChar

Constructor Details

YamlFrontMatterNodeFormatter

public YamlFrontMatterNodeFormatter(DataHolder options)

Method Details

getFormattingPhases

@Nullable
public @Nullable Set<FormattingPhase> getFormattingPhases()

Specified by:

getFormattingPhases in interface PhasedNodeFormatter

getNodeClasses

@Nullable
public @Nullable Set<Class<?>> getNodeClasses()

Description copied from interface: NodeFormatter

Collect nodes of given type so that they can be quickly accessed without traversing the AST by all formatting extensions.

Specified by:

getNodeClasses in interface NodeFormatter

Returns:

the nodes of interest to this formatter during formatting.

renderDocument

public void renderDocument(@NotNull
 @NotNull NodeFormatterContext context,
 @NotNull
 @NotNull MarkdownWriter markdown,
 @NotNull
 @NotNull Document document,
 @NotNull
 @NotNull FormattingPhase phase)

Description copied from interface: PhasedNodeFormatter

Render the specified node.

Specified by:

renderDocument in interface PhasedNodeFormatter

Parameters:

context - node renderer context instance

markdown - markdown writer instance

document - the document node to render

phase - rendering phase for which to generate the output. Will be any of FormattingPhase except FormattingPhase.DOCUMENT because this phase is used for the non-phased node rendering

getNodeFormattingHandlers

@Nullable
public @Nullable Set<NodeFormattingHandler<?>> getNodeFormattingHandlers()

Specified by:

getNodeFormattingHandlers in interface NodeFormatter

Returns:

the mapping of nodes this renderer handles to rendering function

render

private void render(YamlFrontMatterBlock node,
 NodeFormatterContext context,
 MarkdownWriter markdown)