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.util.builder.BuilderBase<Formatter.Builder>

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.builder.BuilderBase<Formatter.Builder>

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

Field Summary

Fields inherited from class com.vladsch.flexmark.util.builder.BuilderBase

EXTENSIONS, RELOAD_EXTENSIONS, UNLOAD_EXTENSIONS

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()
protected boolean	loadExtension(com.vladsch.flexmark.util.builder.Extension extension)
Formatter.Builder	nodeFormatterFactory(NodeFormatterFactory nodeFormatterFactory) Add a factory for instantiating a node renderer (done when rendering).
protected void	preloadExtension(com.vladsch.flexmark.util.builder.Extension extension)
protected void	removeApiPoint(Object apiPoint)

Methods inherited from class com.vladsch.flexmark.util.builder.BuilderBase

addExtensionApiPoint, extensions, loadExtensions, set, unloadExtension, unloadExtensions, withOptions

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

clear, get, getOrCompute, merge, remove, 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

removeApiPoint

protected void removeApiPoint(Object apiPoint)

Specified by:

removeApiPoint in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>

preloadExtension

protected void preloadExtension(com.vladsch.flexmark.util.builder.Extension extension)

Specified by:

preloadExtension in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>

loadExtension

protected boolean loadExtension(com.vladsch.flexmark.util.builder.Extension extension)

Specified by:

loadExtension in class com.vladsch.flexmark.util.builder.BuilderBase<Formatter.Builder>

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