org.commonmark.parser

Class Parser

java.lang.Object

org.commonmark.parser.Parser

public class Parser
extends Object

Parses input text to a tree of nodes.

Start with the builder() method, configure the parser and build it. Example:

 Parser parser = Parser.builder().build();
 Node document = parser.parse("input text");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parser.Builder Builder for configuring a Parser.
static interface	Parser.ParserExtension Extension for Parser.

Method Summary

Modifier and Type	Method and Description
static Parser.Builder	builder() Create a new builder for configuring a Parser.
Node	parse(String input) Parse the specified input text into a tree of nodes.
Node	parseReader(Reader input) Parse the specified reader into a tree of nodes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static Parser.Builder builder()

Create a new builder for configuring a Parser.

Returns:

a builder

parse

public Node parse(String input)

Parse the specified input text into a tree of nodes.

Note that this method is thread-safe (a new parser state is used for each invocation).

Parameters:

input - the text to parse

Returns:

the root node

parseReader

public Node parseReader(Reader input)
                 throws IOException

Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader.

Note that this method is thread-safe (a new parser state is used for each invocation).

Parameters:

input - the reader to parse

Returns:

the root node

Throws:

IOException - when reading throws an exception