* Start with the {@link #builder} method, configure the parser and build it. Example: *
* Parser parser = Parser.builder().build();
* Node document = parser.parse("input text");
* * This method is thread-safe (a new parser state is used for each invocation). * * @param input the text to parse - must not be null * @return the root node */ public Node parse(String input) { if (input == null) { throw new NullPointerException("input must not be null"); } DocumentParser documentParser = createDocumentParser(); Node document = documentParser.parse(input); return postProcess(document); } /** * Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader. *
* Parser parser = Parser.builder().build();
* try (InputStreamReader reader = new InputStreamReader(new FileInputStream("file.md"), StandardCharsets.UTF_8)) {
* Node document = parser.parseReader(reader);
* // ...
* }
*
* This method is thread-safe (a new parser state is used for each invocation).
*
* @param input the reader to parse - must not be null
* @return the root node
* @throws IOException when reading throws an exception
*/
public Node parseReader(Reader input) throws IOException {
if (input == null) {
throw new NullPointerException("input must not be null");
}
DocumentParser documentParser = createDocumentParser();
Node document = documentParser.parse(input);
return postProcess(document);
}
private DocumentParser createDocumentParser() {
return new DocumentParser(blockParserFactories, inlineParserFactory, delimiterProcessors, includeSourceSpans);
}
private Node postProcess(Node document) {
for (PostProcessor postProcessor : postProcessors) {
document = postProcessor.process(document);
}
return document;
}
/**
* Builder for configuring a {@link Parser}.
*/
public static class Builder {
private final List
* By default, CommonMark will recognize and parse the following set of "block" elements:
*
* To parse only a subset of the features listed above, pass a list of each feature's associated {@link Block} class.
*
* E.g., to only parse headings and lists:
*
* By default, source spans are disabled.
*
* @param includeSourceSpans which kind of source spans should be included
* @return {@code this}
* @since 0.16.0
*/
public Builder includeSourceSpans(IncludeSourceSpans includeSourceSpans) {
this.includeSourceSpans = includeSourceSpans;
return this;
}
/**
* 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."
*
* @param blockParserFactory a block parser factory implementation
* @return {@code this}
*/
public Builder customBlockParserFactory(BlockParserFactory blockParserFactory) {
if (blockParserFactory == null) {
throw new NullPointerException("blockParserFactory must not be null");
}
blockParserFactories.add(blockParserFactory);
return this;
}
/**
* 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.
*
* @param delimiterProcessor a delimiter processor implementation
* @return {@code this}
*/
public Builder customDelimiterProcessor(DelimiterProcessor delimiterProcessor) {
if (delimiterProcessor == null) {
throw new NullPointerException("delimiterProcessor must not be null");
}
delimiterProcessors.add(delimiterProcessor);
return this;
}
public Builder postProcessor(PostProcessor postProcessor) {
if (postProcessor == null) {
throw new NullPointerException("postProcessor must not be null");
}
postProcessors.add(postProcessor);
return this;
}
/**
* 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 ()
*
* Note that if this method is not called or the inline parser factory is set to null, then the default
* implementation will be used.
*
* @param inlineParserFactory an inline parser factory implementation
* @return {@code this}
*/
public Builder inlineParserFactory(InlineParserFactory inlineParserFactory) {
this.inlineParserFactory = inlineParserFactory;
return this;
}
private InlineParserFactory getInlineParserFactory() {
if (inlineParserFactory != null) {
return inlineParserFactory;
}
return new InlineParserFactory() {
@Override
public InlineParser create(InlineParserContext inlineParserContext) {
return new InlineParserImpl(inlineParserContext);
}
};
}
}
/**
* Extension for {@link Parser}.
*/
public interface ParserExtension extends Extension {
void extend(Builder parserBuilder);
}
}
*
*
* {@code
* Parser.builder().enabledBlockTypes(new HashSet<>(Arrays.asList(Heading.class, ListBlock.class)));
* }
*
*
* @param enabledBlockTypes A list of block nodes the parser will parse.
* If this list is empty, the parser will not recognize any CommonMark core features.
* @return {@code this}
*/
public Builder enabledBlockTypes(Set