com.vladsch.flexmark.formatter

Class Formatter.Builder

java.lang.Object

com.vladsch.flexmark.util.options.DataSet

com.vladsch.flexmark.util.options.MutableDataSet

com.vladsch.flexmark.formatter.Formatter.Builder

All Implemented Interfaces:

com.vladsch.flexmark.util.options.DataHolder, com.vladsch.flexmark.util.options.MutableDataHolder, com.vladsch.flexmark.util.options.MutableDataSetter

Enclosing class:

Formatter

public static class Formatter.Builder
extends com.vladsch.flexmark.util.options.MutableDataSet

Builder for configuring an Formatter. See methods for default configuration.

Field Summary

Fields inherited from class com.vladsch.flexmark.util.options.DataSet

dataSet

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(com.vladsch.flexmark.util.options.DataHolder options)
Builder(Formatter.Builder other)
Builder(Formatter.Builder other, com.vladsch.flexmark.util.options.DataHolder options)

Method Summary

Modifier and Type	Method and Description
Formatter	build()
Formatter.Builder	extensions(Iterable<? extends com.vladsch.flexmark.Extension> extensions)
Formatter.Builder	nodeFormatterFactory(NodeFormatterFactory nodeFormatterFactory) Add a factory for instantiating a node renderer (done when rendering).

Methods inherited from class com.vladsch.flexmark.util.options.MutableDataSet

clear, get, getOrCompute, merge, remove, set, setAll, setFrom, setIn, toImmutable, toMutable

Methods inherited from class com.vladsch.flexmark.util.options.DataSet

contains, getAll, keySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vladsch.flexmark.util.options.DataHolder

contains, getAll, keySet

Constructor Detail

Builder

public Builder()

Builder

public Builder(com.vladsch.flexmark.util.options.DataHolder options)

Builder

public Builder(Formatter.Builder other)

Builder

public Builder(Formatter.Builder other,
               com.vladsch.flexmark.util.options.DataHolder options)

Method Detail

build

public Formatter build()

Returns:

the configured Formatter

nodeFormatterFactory

public Formatter.Builder nodeFormatterFactory(NodeFormatterFactory nodeFormatterFactory)

Add a factory for instantiating a node renderer (done when rendering). This allows to override the rendering of node types or define rendering for custom node types.

If multiple node renderers for the same node type are created, the one from the factory that was added first "wins". (This is how the rendering for core node types can be overridden; the default rendering comes last.)

Parameters:

nodeFormatterFactory - the factory for creating a node renderer

Returns:

this

extensions

public Formatter.Builder extensions(Iterable<? extends com.vladsch.flexmark.Extension> extensions)

Parameters:

extensions - extensions to use on this HTML renderer

Returns:

this