com.vladsch.flexmark.util

Interface IParse

public interface IParse

Interface to generic parser for RenderingTestCase customizations

Method Summary

Modifier and Type	Method and Description
DataHolder	getOptions() Get Options for parsing
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.
boolean	transferReferences(Document document, Document included) Deprecated. use transferReferences(Document, Document, Boolean)
boolean	transferReferences(Document document, Document included, Boolean onlyIfUndefined) Transfer reference definition between documents
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

getOptions

DataHolder getOptions()

Get Options for parsing

Returns:

DataHolder for options

transferReferences

@Deprecated
boolean transferReferences(Document document,
                                       Document included)

Deprecated. use transferReferences(Document, Document, Boolean)

Transfer reference definition between documents

Parameters:

document - destination document

included - source document

Returns:

true if any references were transferred

transferReferences

boolean transferReferences(Document document,
                           Document included,
                           Boolean onlyIfUndefined)

Transfer reference definition between documents

Parameters:

document - destination document

included - source document

onlyIfUndefined - true if only should transfer references not already defined in the destination document, false to transfer all, null to use repository's KEEP_TYPE to make the determination (if KEEP_FIRST then only transfer if undefined,

Returns:

true if any references were transferred