Parser.Builder (commonmark-java core 0.17.0 API)

java.lang.Object
- org.commonmark.parser.Parser.Builder

Enclosing class:

Parser
```
public static class Parser.Builder
extends Object
```
Builder for configuring a Parser.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Parser`	`build()`
`Parser.Builder`	`customBlockParserFactory(BlockParserFactory blockParserFactory)` Adds a custom block parser factory.
`Parser.Builder`	`customDelimiterProcessor(DelimiterProcessor delimiterProcessor)` Adds a custom delimiter processor.
`Parser.Builder`	`enabledBlockTypes(Set<Class<? extends Block>> enabledBlockTypes)` Describe the list of markdown features the parser will recognize and parse.
`Parser.Builder`	`extensions(Iterable<? extends Extension> extensions)`
`Parser.Builder`	`includeSourceSpans(IncludeSourceSpans includeSourceSpans)` Whether to calculate `SourceSpan` for `Node`.
`Parser.Builder`	`inlineParserFactory(InlineParserFactory inlineParserFactory)` Overrides the parser used for inline markdown processing.
`Parser.Builder`	`postProcessor(PostProcessor postProcessor)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public Parser build()
```
    Returns:
    
    the configured Parser
  - extensions
```
public Parser.Builder extensions(Iterable<? extends Extension> extensions)
```
    Parameters:
    
    extensions - extensions to use on this parser
    
    Returns:
    
    this
  - enabledBlockTypes
```
public Parser.Builder enabledBlockTypes(Set<Class<? extends Block>> enabledBlockTypes)
```
    Describe the list of markdown features the parser will recognize and parse.
    By default, CommonMark will recognize and parse the following set of "block" elements:
    - Heading (#)
    - HtmlBlock (<html></html>)
    - ThematicBreak (Horizontal Rule) (---)
    - FencedCodeBlock (```)
    - IndentedCodeBlock
    - BlockQuote (>)
    - ListBlock (Ordered / Unordered List) (1. / *)
    To parse only a subset of the features listed above, pass a list of each feature's associated Block class.
    E.g., to only parse headings and lists:
```
     
     Parser.builder().enabledBlockTypes(new HashSet<>(Arrays.asList(Heading.class, ListBlock.class)));
     
 
```
    Parameters:
    
    enabledBlockTypes - A list of block nodes the parser will parse. If this list is empty, the parser will not recognize any CommonMark core features.
    
    Returns:
    
    this
  - includeSourceSpans
```
public Parser.Builder includeSourceSpans(IncludeSourceSpans includeSourceSpans)
```
    Whether to calculate SourceSpan for Node.
    By default, source spans are disabled.
    
    Parameters:
    
    includeSourceSpans - which kind of source spans should be included
    
    Returns:
    
    this
    
    Since:
    
    0.16.0
  - customBlockParserFactory
```
public Parser.Builder customBlockParserFactory(BlockParserFactory 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
  - customDelimiterProcessor
```
public Parser.Builder customDelimiterProcessor(DelimiterProcessor delimiterProcessor)
```
    Adds a custom delimiter processor.
    Note that multiple delimiter processors with the same characters can be added, as long as they have a different minimum length. In that case, the processor with the shortest matching length is used. Adding more than one delimiter processor with the same character and minimum length is invalid.
    
    Parameters:
    
    delimiterProcessor - a delimiter processor implementation
    
    Returns:
    
    this
  - postProcessor
```
public Parser.Builder postProcessor(PostProcessor postProcessor)
```
  - inlineParserFactory
```
public Parser.Builder inlineParserFactory(InlineParserFactory inlineParserFactory)
```
    Overrides the parser used for inline markdown processing.
    Provide an implementation of InlineParserFactory which provides a custom inline parser to modify how the following are parsed: bold (**) italic (*) strikethrough (~~) backtick quote (`) link ([title](http://)) image (![alt](http://))
    Note that if this method is not called or the inline parser factory is set to null, then the default implementation will be used.
    
    Parameters:
    
    inlineParserFactory - an inline parser factory implementation
    
    Returns:
    
    this

Class Parser.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

extensions

enabledBlockTypes

includeSourceSpans

customBlockParserFactory

customDelimiterProcessor

postProcessor

inlineParserFactory