Top Fields Constructors Methods

com.vladsch.flexmark.formatter

public abstract Class NodeRepositoryFormatter<R extends NodeRepository<B>, B extends Node & ReferenceNode<R, B, N>, N extends Node & ReferencingNode<R, B>>

Class Inheritance

extends Object
implements PhasedNodeFormatter

java.lang.Object
com.vladsch.flexmark.formatter.NodeRepositoryFormatter

All Implemented Interfaces

com.vladsch.flexmark.formatter.PhasedNodeFormatter, com.vladsch.flexmark.formatter.NodeFormatter

Known Direct Subclasses

com.vladsch.flexmark.formatter.internal.CoreNodeFormatter

Imports

com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.util.ast.*, com.vladsch.flexmark.util.data.DataHolder, .DataKey, .DataSet, com.vladsch.flexmark.util.format.options.ElementPlacement, .ElementPlacementSort, org.jetbrains.annotations.NotNull, .Nullable, java.util.*

Field Summary

Modifier and Type	Field and Description
public static final HashSet<FormattingPhase>	FORMATTING_PHASES
protected final B	lastReference
protected final Comparator<B>	myComparator
private final DataKey<Map<String, String>>	myReferenceMapKey
private final DataKey<Map<String, String>>	myReferenceUniqificationMapKey
protected boolean	recheckUndefinedReferences
protected final List<B>	referenceList
protected final R	referenceRepository
private Map<String, String>	referenceTranslationMap
protected Map<String, String>	referenceUniqificationMap
protected boolean	repositoryNodesDone
protected final HashSet<Node>	unusedReferences

Constructor Summary

Access	Constructor and Description
public	NodeRepositoryFormatter(DataHolder options, DataKey<Map<String, String>> referenceMapKey, DataKey<Map<String, String>> uniquificationMapKey)

Method Summary

Modifier and Type	Method and Description
private void	formatReferences(NodeFormatterContext context, MarkdownWriter markdown)
public @Nullable Set<FormattingPhase>	getFormattingPhases() Implements com.vladsch.flexmark.formatter.PhasedNodeFormatter.getFormattingPhases.
public Comparator<B>	getReferenceComparator()
public abstract ElementPlacement	getReferencePlacement()
public abstract ElementPlacementSort	getReferenceSort()
public abstract R	getRepository(DataHolder options)
protected ElementPlacement	getTranslationReferencePlacement(NodeFormatterContext context)
protected boolean	Returns: true if yes, false if leave all references as is makeReferencesUnique() Whether references should be made unique
public String	modifyTransformedReference(String transformedReferenceId, NodeFormatterContext context)
public void	renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase)
protected void	renderReference(B node, NodeFormatterContext context, MarkdownWriter markdown)
protected abstract void	renderReferenceBlock(B node, NodeFormatterContext context, MarkdownWriter markdown)
private void	renderReferenceBlockUnique(B node, NodeFormatterContext context, MarkdownWriter markdown)
protected String	transformReferenceId(String nodeText, NodeFormatterContext context)
protected void	uniquifyIds(NodeFormatterContext context, MarkdownWriter markdown, Document document) Compute needed id map to make reference ids unique across documents[] up to entry equal to document and store this map in document property so that it can be retrieved from the document later when computing the map by documents after this document in the list.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FORMATTING_PHASES	back to summary
public static final HashSet<FormattingPhase> FORMATTING_PHASES

lastReference	back to summary
protected final B lastReference

myComparator	back to summary
protected final Comparator<B> myComparator

myReferenceMapKey	back to summary
private final DataKey<Map<String, String>> myReferenceMapKey

myReferenceUniqificationMapKey	back to summary
private final DataKey<Map<String, String>> myReferenceUniqificationMapKey

recheckUndefinedReferences	back to summary
protected boolean recheckUndefinedReferences

referenceList	back to summary
protected final List<B> referenceList

referenceRepository	back to summary
protected final R referenceRepository

referenceTranslationMap	back to summary
private Map<String, String> referenceTranslationMap

referenceUniqificationMap	back to summary
protected Map<String, String> referenceUniqificationMap

repositoryNodesDone	back to summary
protected boolean repositoryNodesDone

unusedReferences	back to summary
protected final HashSet<Node> unusedReferences

Constructor Detail

NodeRepositoryFormatter	back to summary
public NodeRepositoryFormatter(DataHolder options, DataKey<Map<String, String>> referenceMapKey, DataKey<Map<String, String>> uniquificationMapKey)

Method Detail

formatReferences	back to summary
private void formatReferences(NodeFormatterContext context, MarkdownWriter markdown)

getFormattingPhases

back to summary

public @Nullable Set<FormattingPhase> getFormattingPhases()

Implements com.vladsch.flexmark.formatter.PhasedNodeFormatter.getFormattingPhases.

Annotations

@Nullable
@Override

getReferenceComparator	back to summary
public Comparator<B> getReferenceComparator()

getReferencePlacement	back to summary
public abstract ElementPlacement getReferencePlacement()

getReferenceSort	back to summary
public abstract ElementPlacementSort getReferenceSort()

getRepository	back to summary
public abstract R getRepository(DataHolder options)

getTranslationReferencePlacement	back to summary
protected ElementPlacement getTranslationReferencePlacement(NodeFormatterContext context)

makeReferencesUnique

back to summary

protected boolean makeReferencesUnique()

Whether references should be made unique

Returns:boolean: true if yes, false if leave all references as is

modifyTransformedReference	back to summary
public String modifyTransformedReference(String transformedReferenceId, NodeFormatterContext context)

renderDocument	back to summary
public void renderDocument(@NotNull NodeFormatterContext context, @NotNull MarkdownWriter markdown, @NotNull Document document, @NotNull FormattingPhase phase) Annotations @Override

renderReference	back to summary
protected void renderReference(B node, NodeFormatterContext context, MarkdownWriter markdown)

renderReferenceBlock	back to summary
protected abstract void renderReferenceBlock(B node, NodeFormatterContext context, MarkdownWriter markdown)

renderReferenceBlockUnique	back to summary
private void renderReferenceBlockUnique(B node, NodeFormatterContext context, MarkdownWriter markdown)

transformReferenceId	back to summary
protected String transformReferenceId(String nodeText, NodeFormatterContext context)

uniquifyIds	back to summary
protected void uniquifyIds(NodeFormatterContext context, MarkdownWriter markdown, Document document) Compute needed id map to make reference ids unique across documents[] up to entry equal to document and store this map in document property so that it can be retrieved from the document later when computing the map by documents after this document in the list.