Class FlexmarkHtmlConverter.Builder

java.lang.Object

com.vladsch.flexmark.util.data.DataSet

com.vladsch.flexmark.util.data.MutableDataSet

com.vladsch.flexmark.util.builder.BuilderBase<FlexmarkHtmlConverter.Builder>

com.vladsch.flexmark.html2md.converter.FlexmarkHtmlConverter.Builder

All Implemented Interfaces:

DataHolder, MutableDataHolder, MutableDataSetter

Enclosing class:

FlexmarkHtmlConverter

public static class FlexmarkHtmlConverter.Builder
extends BuilderBase<FlexmarkHtmlConverter.Builder>

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

Field Summary

Fields

Modifier and Type	Field	Description
(package private) HeaderIdGeneratorFactory	htmlIdGeneratorFactory
(package private) List<HtmlLinkResolverFactory>	linkResolverFactories
(package private) List<HtmlNodeRendererFactory>	nodeRendererFactories

Fields inherited from class DataSet

dataSet

Fields inherited from interface DataHolder

NULL

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(@Nullable DataHolder options)

Method Summary

Modifier and Type	Method	Description
@NotNull FlexmarkHtmlConverter	build()
FlexmarkHtmlConverter.Builder	htmlNodeRendererFactory(@NotNull HtmlNodeRendererFactory htmlNodeRendererFactory)	Add a factory for instantiating a node renderer (done when rendering).
FlexmarkHtmlConverter.Builder	linkResolverFactory(@NotNull HtmlLinkResolverFactory linkResolverFactory)	Add a factory for instantiating a node renderer (done when rendering).
protected boolean	loadExtension(@NotNull Extension extension)	Load extension if it is valid
protected void	preloadExtension(@NotNull Extension extension)	Preload operation for extension, perform any data config and other operation needed for loading extension
protected void	removeApiPoint(@NotNull Object apiPoint)	Remove apiPoint from state information

Methods inherited from class BuilderBase

addExtensionApiPoint, extensions, get, loadExtensions, removeExtensions, set, set

Methods inherited from class MutableDataSet

clear, getOrCompute, merge, remove, setAll, setFrom, setIn, toDataSet, toImmutable, toMutable

Methods inherited from class DataSet

aggregate, aggregate, aggregateActions, contains, equals, getAll, getKeys, hashCode, registerDataKeyAggregator, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DataHolder

contains, getAll, getKeys

Field Details

nodeRendererFactories

List<HtmlNodeRendererFactory> nodeRendererFactories

linkResolverFactories

List<HtmlLinkResolverFactory> linkResolverFactories

htmlIdGeneratorFactory

HeaderIdGeneratorFactory htmlIdGeneratorFactory

Constructor Details

Builder

public Builder()

Builder

public Builder(@Nullable
 @Nullable DataHolder options)

Method Details

build

@NotNull
public @NotNull FlexmarkHtmlConverter build()

Specified by:

build in class BuilderBase<FlexmarkHtmlConverter.Builder>

Returns:

the configured FlexmarkHtmlConverter

removeApiPoint

protected void removeApiPoint(@NotNull
 @NotNull Object apiPoint)

Description copied from class: BuilderBase

Remove apiPoint from state information

Specified by:

removeApiPoint in class BuilderBase<FlexmarkHtmlConverter.Builder>

Parameters:

apiPoint - api point object

preloadExtension

protected void preloadExtension(@NotNull
 @NotNull Extension extension)

Description copied from class: BuilderBase

Preload operation for extension, perform any data config and other operation needed for loading extension

Specified by:

preloadExtension in class BuilderBase<FlexmarkHtmlConverter.Builder>

Parameters:

extension - to preload

loadExtension

protected boolean loadExtension(@NotNull
 @NotNull Extension extension)

Description copied from class: BuilderBase

Load extension if it is valid

Specified by:

loadExtension in class BuilderBase<FlexmarkHtmlConverter.Builder>

Parameters:

extension - to load

Returns:

true if extension was loaded

htmlNodeRendererFactory

public FlexmarkHtmlConverter.Builder htmlNodeRendererFactory(@NotNull
 @NotNull HtmlNodeRendererFactory htmlNodeRendererFactory)

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:

htmlNodeRendererFactory - the factory for creating a node renderer

Returns:

this

linkResolverFactory

public FlexmarkHtmlConverter.Builder linkResolverFactory(@NotNull
 @NotNull HtmlLinkResolverFactory linkResolverFactory)

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:

linkResolverFactory - the factory for creating a node renderer

Returns:

this