Top Description Inners Fields Constructors Methods
com.vladsch.flexmark.formatter

public Class Formatter

extends Object
implements IRender
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.ast.IRender
Annotations
@SuppressWarnings:WeakerAccess
Imports
com.vladsch.flexmark.formatter.internal.*, com.vladsch.flexmark.html.AttributeProviderFactory, .LinkResolver, .LinkResolverFactory, com.vladsch.flexmark.html.renderer.*, com.vladsch.flexmark.parser.Parser, .ParserEmulationProfile, com.vladsch.flexmark.util.ast.*, com.vladsch.flexmark.util.builder.BuilderBase, com.vladsch.flexmark.util.collection.SubClassingBag, com.vladsch.flexmark.util.data.*, com.vladsch.flexmark.util.dependency.DependencyResolver, com.vladsch.flexmark.util.format.*, com.vladsch.flexmark.util.format.options.*, com.vladsch.flexmark.util.html.Attributes, com.vladsch.flexmark.util.misc.CharPredicate, .Extension, com.vladsch.flexmark.util.sequence.BasedSequence, .LineAppendable, .SequenceUtils, com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder, .SequenceBuilder, org.jetbrains.annotations.NotNull, .Nullable, java.util.*, java.util.function.Function, .Supplier, java.util.regex.Pattern
Renders a tree of nodes to Markdown.

Start with the builder method to configure the renderer. Example: 


Formatter formatter = Formatter.builder().build();
formatter.render(node);

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Formatter.Builder

Builder for configuring an Formatter.

public static interface
Formatter.FormatterExtension

Extension for Formatter.

private class
Formatter.MainNodeFormatter

Field Summary

Modifier and TypeField and Description
public static final DataKey<Boolean>
APPEND_TRANSFERRED_REFERENCES

public static final DataKey<Boolean>
APPLY_SPECIAL_LEAD_IN_HANDLERS

public static final DataKey<Map<String, String>>
ATTRIBUTE_UNIQUIFICATION_ID_MAP

public static final DataKey<EqualizeTrailingMarker>
ATX_HEADER_TRAILING_MARKER

Deprecated
use corrected name
public static final DataKey<EqualizeTrailingMarker>
ATX_HEADING_TRAILING_MARKER

public static final DataKey<Boolean>
BLOCK_QUOTE_BLANK_LINES

public static final DataKey<BlockQuoteMarker>
BLOCK_QUOTE_MARKERS

public static final DataKey<String>
DOC_RELATIVE_URL

public static final DataKey<String>
DOC_ROOT_URL

public static final DataKey<CharSequence>
DOCUMENT_FIRST_PREFIX

public static final DataKey<CharSequence>
DOCUMENT_PREFIX

public static final Document[]
EMPTY_DOCUMENTS

public static final DataKey<Boolean>
ESCAPE_NUMBERED_LEAD_IN

public static final DataKey<Boolean>
ESCAPE_SPECIAL_CHARS

public static final DataKey<Integer>
FENCED_CODE_MARKER_LENGTH

public static final DataKey<CodeFenceMarker>
FENCED_CODE_MARKER_TYPE

public static final DataKey<Boolean>
FENCED_CODE_MATCH_CLOSING_MARKER

public static final DataKey<Boolean>
FENCED_CODE_MINIMIZE_INDENT

public static final DataKey<Boolean>
FENCED_CODE_SPACE_BEFORE_INFO

public static final int
FORMAT_ALL_OPTIONS

Deprecated
public static final DataKey<CharWidthProvider>
FORMAT_CHAR_WIDTH_PROVIDER

public static final int
FORMAT_COLLAPSE_WHITESPACE

Deprecated
public static final int
FORMAT_CONVERT_TABS

Deprecated
public static final DataKey<Integer>
FORMAT_FLAGS

output control for FormattingAppendable, see LineAppendable#setOptions(int)

public static final int
FORMAT_SUPPRESS_TRAILING_WHITESPACE

Deprecated
public static final DataKey<TableCaptionHandling>
FORMAT_TABLE_CAPTION

Deprecated
use TableFormatOptions instead
public static final DataKey<DiscretionaryText>
FORMAT_TABLE_CAPTION_SPACES

Deprecated
use TableFormatOptions instead
public static final DataKey<String>
FORMAT_TABLE_INDENT_PREFIX

Deprecated
use TableFormatOptions instead
public static final DataKey<ParserEmulationProfile>
FORMATTER_EMULATION_PROFILE

public static final DataKey<String>
FORMATTER_OFF_TAG

public static final DataKey<String>
FORMATTER_ON_TAG

public static final DataKey<Boolean>
FORMATTER_TAGS_ACCEPT_REGEXP

public static final DataKey<Boolean>
FORMATTER_TAGS_ENABLED

public static final DataKey<Boolean>
GENERATE_HEADER_ID

public static final DataKey<HeadingStyle>
HEADING_STYLE

pack-priv final HeaderIdGeneratorFactory
idGeneratorFactory

public static final DataKey<Boolean>
INDENTED_CODE_MINIMIZE_INDENT

public static final DataKey<Boolean>
KEEP_HARD_LINE_BREAKS

public static final DataKey<Boolean>
KEEP_SOFT_LINE_BREAKS

pack-priv final List<LinkResolverFactory>
linkResolverFactories

public static final DataKey<Boolean>
LIST_ADD_BLANK_LINE_BEFORE

public static final DataKey<ElementAlignment>
LIST_ALIGN_NUMERIC

public static final DataKey<ListBulletMarker>
LIST_BULLET_MARKER

public static final DataKey<ListNumberedMarker>
LIST_NUMBERED_MARKER

public static final DataKey<Boolean>
LIST_REMOVE_EMPTY_ITEMS

public static final DataKey<Boolean>
LIST_RENUMBER_ITEMS

public static final DataKey<Boolean>
LIST_RESET_FIRST_ITEM_NUMBER

public static final DataKey<ListSpacing>
LIST_SPACING

public static final DataKey<Boolean>
LISTS_ITEM_CONTENT_AFTER_SUFFIX

public static final DataKey<Integer>
MAX_BLANK_LINES

public static final DataKey<Integer>
MAX_TRAILING_BLANK_LINES

pack-priv final List<NodeFormatterFactory>
nodeFormatterFactories

public static final Iterable<Node>
NULL_ITERABLE

private static final Iterator<Node>
NULL_ITERATOR

public static final DataKey<Boolean>
OPTIMIZED_INLINE_RENDERING

private final DataHolder
options

public static final DataKey<ElementPlacement>
REFERENCE_PLACEMENT

public static final DataKey<ElementPlacementSort>
REFERENCE_SORT

public static final DataKey<Boolean>
RESTORE_TRACKED_SPACES

public static final DataKey<Integer>
RIGHT_MARGIN

public static final DataKey<Boolean>
SETEXT_HEADER_EQUALIZE_MARKER

Deprecated
use corrected name
public static final DataKey<Boolean>
SETEXT_HEADING_EQUALIZE_MARKER

public static final DataKey<DiscretionaryText>
SPACE_AFTER_ATX_MARKER

public static final NullableDataKey<String>
THEMATIC_BREAK

public static final DataKey<List<TrackedOffset>>
TRACKED_OFFSETS

public static final DataKey<BasedSequence>
TRACKED_SEQUENCE

public static final DataKey<String>
TRANSLATION_EXCLUDE_PATTERN

public static final DataKey<String>
TRANSLATION_HTML_BLOCK_PREFIX

public static final DataKey<String>
TRANSLATION_HTML_BLOCK_TAG_PATTERN

public static final DataKey<String>
TRANSLATION_HTML_INLINE_PREFIX

public static final DataKey<String>
TRANSLATION_HTML_INLINE_TAG_PATTERN

public static final DataKey<String>
TRANSLATION_ID_FORMAT

public static final DataKey<Boolean>
UNESCAPE_SPECIAL_CHARS

public static final DataKey<Map<String, String>>
UNIQUIFICATION_MAP

Constructor Summary

AccessConstructor and Description
pack-priv
Formatter(Formatter.Builder builder)

Method Summary

Modifier and TypeMethod and Description
public static Formatter.Builder

Returns:

a builder
builder()

Create a new builder for configuring an Formatter.

public static Formatter.Builder

Returns:

a builder.
builder(DataHolder
initialization options
options)

Create a new builder for configuring an Formatter.

private static List<NodeFormatterFactory>
calculateNodeFormatterFactories(List<NodeFormatterFactory> formatterFactories)

public @NotNull DataHolder
getOptions()

Implements com.vladsch.flexmark.util.ast.IRender.getOptions.

Get Options for parsing

public TranslationHandler
getTranslationHandler(TranslationHandlerFactory translationHandlerFactory, HtmlIdGeneratorFactory idGeneratorFactory)

public TranslationHandler
getTranslationHandler(HtmlIdGeneratorFactory idGeneratorFactory)

public TranslationHandler
getTranslationHandler()

public void
mergeRender(Document[]
node to render
documents, Appendable
appendable to use for the output
output)

Render a node to the appendable

public void
mergeRender(List<Document> documents, Appendable output)

public String

Returns:

the formatted markdown
mergeRender(Document[]
the root node
documents, int maxTrailingBlankLines)

Render the tree of nodes to markdown

public String
mergeRender(List<Document> documents, int maxTrailingBlankLines)

public void
mergeRender(List<Document>
nodes to merge render
documents, Appendable
appendable to use for the output
output, int maxTrailingBlankLines)

Render a node to the appendable

public void
mergeRender(Document[] documents, Appendable output, int maxTrailingBlankLines)

public void
render(@NotNull Node
node to render
node, @NotNull Appendable
appendable to use for the output
output)

Render a node to the appendable

Note

if Appendable is LineAppendable then its builder will be used as builder for the markdown text, else string sequence builder will be used

public void
render(@NotNull Node
node to render
node, @NotNull Appendable
appendable to which to render the resulting text
output, int
max trailing blank lines in output, -1 means no last line EOL
maxTrailingBlankLines)

Render node

Note

if Appendable is LineAppendable then its builder will be used as builder for the markdown text, else string sequence builder will be used

public @NotNull String

Returns:

the formatted markdown
render(@NotNull Node
the root node
document)

Render the tree of nodes to markdown

public void
translationRender(Node
node to render
document, Appendable
appendable to use for the output
output, TranslationHandler translationHandler, RenderPurpose renderPurpose)

Render a node to the appendable

public String

Returns:

the formatted markdown
translationRender(Node
the root node
document, TranslationHandler translationHandler, RenderPurpose renderPurpose)

Render the tree of nodes to markdown

public void
translationRender(Node
node to render
document, Appendable
appendable to use for the output
output, int maxTrailingBlankLines, TranslationHandler translationHandler, RenderPurpose renderPurpose)

Render a node to the appendable

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait