Class Parser.Builder

java.lang.Object

com.vladsch.flexmark.util.data.DataSet

com.vladsch.flexmark.util.data.MutableDataSet

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

com.vladsch.flexmark.parser.Parser.Builder

All Implemented Interfaces:

DataHolder, MutableDataHolder, MutableDataSetter

Enclosing class:

Parser

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

Builder for configuring a Parser.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final List<CustomBlockParserFactory>	blockParserFactories
(package private) final List<BlockPreProcessorFactory>	blockPreProcessorFactories
(package private) final List<DelimiterProcessor>	delimiterProcessors
(package private) final List<InlineParserExtensionFactory>	inlineParserExtensionFactories
(package private) InlineParserFactory	inlineParserFactory
(package private) final List<LinkRefProcessorFactory>	linkRefProcessors
(package private) final List<ParagraphPreProcessorFactory>	paragraphPreProcessorFactories
(package private) final List<PostProcessorFactory>	postProcessorFactories
(package private) final List<SpecialLeadInHandler>	specialLeadInHandlers

Fields inherited from class DataSet

dataSet

Fields inherited from interface DataHolder

NULL

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(DataHolder options)

Method Summary

Modifier and Type	Method	Description
Parser.Builder	blockPreProcessorFactory(BlockPreProcessorFactory blockPreProcessorFactory)
@NotNull Parser	build()
Parser.Builder	customBlockParserFactory(CustomBlockParserFactory blockParserFactory)	Adds a custom block parser factory.
Parser.Builder	customDelimiterProcessor(DelimiterProcessor delimiterProcessor)
Parser.Builder	customInlineParserExtensionFactory(InlineParserExtensionFactory inlineParserExtensionFactory)
Parser.Builder	customInlineParserFactory(InlineParserFactory blockParserFactory)
Parser.Builder	linkRefProcessorFactory(LinkRefProcessorFactory linkRefProcessor)
protected boolean	loadExtension(@NotNull Extension extension)	Load extension if it is valid
Parser.Builder	paragraphPreProcessorFactory(ParagraphPreProcessorFactory paragraphPreProcessorFactory)
Parser.Builder	postProcessorFactory(PostProcessorFactory postProcessorFactory)
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
Parser.Builder	specialLeadInHandler(SpecialLeadInHandler specialLeadInHandler)

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

blockParserFactories

final List<CustomBlockParserFactory> blockParserFactories

delimiterProcessors

final List<DelimiterProcessor> delimiterProcessors

postProcessorFactories

final List<PostProcessorFactory> postProcessorFactories

paragraphPreProcessorFactories

final List<ParagraphPreProcessorFactory> paragraphPreProcessorFactories

blockPreProcessorFactories

final List<BlockPreProcessorFactory> blockPreProcessorFactories

linkRefProcessors

final List<LinkRefProcessorFactory> linkRefProcessors

inlineParserExtensionFactories

final List<InlineParserExtensionFactory> inlineParserExtensionFactories

inlineParserFactory

InlineParserFactory inlineParserFactory

specialLeadInHandlers

final List<SpecialLeadInHandler> specialLeadInHandlers

Constructor Details

Builder

public Builder(DataHolder options)

Builder

public Builder()

Method Details

build

@NotNull
public @NotNull Parser build()

Specified by:

build in class BuilderBase<Parser.Builder>

Returns:

the configured Parser

removeApiPoint

protected void removeApiPoint(@NotNull
 @NotNull Object apiPoint)

Description copied from class: BuilderBase

Remove apiPoint from state information

Specified by:

removeApiPoint in class BuilderBase<Parser.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<Parser.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<Parser.Builder>

Parameters:

extension - to load

Returns:

true if extension was loaded

customBlockParserFactory

public Parser.Builder customBlockParserFactory(CustomBlockParserFactory blockParserFactory)

Adds a custom block parser factory.

Note that custom factories are applied before the built-in factories. This is so that extensions can change how some syntax is parsed that would otherwise be handled by built-in factories. "With great power comes great responsibility."

Parameters:

blockParserFactory - a block parser factory implementation

Returns:

this

customInlineParserExtensionFactory

public Parser.Builder customInlineParserExtensionFactory(InlineParserExtensionFactory inlineParserExtensionFactory)

customInlineParserFactory

public Parser.Builder customInlineParserFactory(InlineParserFactory blockParserFactory)

customDelimiterProcessor

public Parser.Builder customDelimiterProcessor(DelimiterProcessor delimiterProcessor)

postProcessorFactory

public Parser.Builder postProcessorFactory(PostProcessorFactory postProcessorFactory)

paragraphPreProcessorFactory

public Parser.Builder paragraphPreProcessorFactory(ParagraphPreProcessorFactory paragraphPreProcessorFactory)

blockPreProcessorFactory

public Parser.Builder blockPreProcessorFactory(BlockPreProcessorFactory blockPreProcessorFactory)

linkRefProcessorFactory

public Parser.Builder linkRefProcessorFactory(LinkRefProcessorFactory linkRefProcessor)

specialLeadInHandler

public Parser.Builder specialLeadInHandler(SpecialLeadInHandler specialLeadInHandler)