com.vladsch.flexmark

Interface IParse

public interface IParse

Interface to generic parser for RenderingTestCase customizations

Method Summary

Modifier and Type	Method and Description
Node	parse(BasedSequence input) Parse the specified input text into a tree of nodes.
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.
IParse	withOptions(DataHolder options) Return an IParse instance configured for passed in options

Method Detail

parse

Node parse(BasedSequence 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

parse

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

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

withOptions

IParse withOptions(DataHolder options)

Return an IParse instance configured for passed in options

Parameters:

options - options to use for a new instance

Returns:

a new instance of IParse implementation with the given options applied